Loading

MCP server

docs-builder includes an MCP (Model Context Protocol) server that allows AI assistants and coding agents to interact with Elastic documentation directly.

The MCP server is deployed as a stateless HTTP service and exposes all tools through a single Streamable HTTP endpoint at https://www.elastic.co/docs/_mcp/.

Add the docs-builder MCP server to your editor or AI assistant using one of the options below.

To install automatically, copy and paste the following link into your browser's address bar:

cursor://anysphere.cursor-deeplink/mcp/install?name=elastic-docs&config=eyJ1cmwiOiJodHRwczovL3d3dy5lbGFzdGljLmNvL2RvY3MvX21jcC8ifQ==

Cursor will prompt you to install the elastic-docs MCP server.

Or configure manually. Create or edit .cursor/mcp.json in your workspace:

{
  "mcpServers": {
    "elastic-docs": {
      "url": "https://www.elastic.co/docs/_mcp/"
    }
  }
}

Then restart Cursor or reload the window. The tools will be available in Agent mode.

Run the following command to add the server to your current project:

claude mcp add --transport http elastic-docs https://www.elastic.co/docs/_mcp/

To make it available across all your projects, add the --scope user flag:

claude mcp add --scope user --transport http elastic-docs https://www.elastic.co/docs/_mcp/

Or add it manually to your project's .mcp.json file:

{
  "mcpServers": {
    "elastic-docs": {
      "type": "http",
      "url": "https://www.elastic.co/docs/_mcp/"
    }
  }
}

To install automatically (requires VS Code 1.99+), copy and paste the following link into your browser's address bar:

vscode:mcp/install?%7B%22name%22%3A%22elastic-docs%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fwww.elastic.co%2Fdocs%2F_mcp%2F%22%7D

VS Code will prompt you to install the elastic-docs MCP server.

Or configure manually. Create or edit .vscode/mcp.json in your workspace:

{
  "servers": {
    "elastic-docs": {
      "type": "http",
      "url": "https://www.elastic.co/docs/_mcp/"
    }
  }
}

Requires GitHub Copilot with agent mode enabled.

Configure the server through the IDE settings:

  1. Open Settings → Tools → AI Assistant → Model Context Protocol.
  2. Click Add and select HTTP as the connection type.
  3. Enter https://www.elastic.co/docs/_mcp/ as the server URL, and elastic-docs as the name.
  4. Click OK and apply the settings.

Or configure it directly via JSON by adding the following to your MCP settings file:

{
  "mcpServers": {
    "elastic-docs": {
      "url": "https://www.elastic.co/docs/_mcp/"
    }
  }
}

Requires JetBrains AI Assistant plugin version 2025.2 or later.

Tool Description
ResolveCrossLink Resolves a cross-link (like docs-content://get-started/intro.md) to its target URL and returns available anchors.
ListRepositories Lists all repositories available in the cross-link index with their metadata.
GetRepositoryLinks Gets all pages and their anchors published by a specific repository.
FindCrossLinks Finds all cross-links between repositories. Can filter by source or target repository.
ValidateCrossLinks Validates cross-links to a repository and reports any broken links.

Content type tools

These tools help authors create and evaluate documentation using the Elastic Docs content types.

Tool Description
ListContentTypes Lists all Elastic Docs content types with descriptions and guidance on when to use each.
GenerateTemplate Generates a ready-to-use template for a specific content type (overview, how-to, tutorial, troubleshooting, or changelog). Optionally pre-fills title, description, and product.
GetContentTypeGuidelines Returns detailed authoring and evaluation guidelines for a content type, including required elements, best practices, and anti-patterns.
Tool Description
SemanticSearch Performs semantic search across all Elastic documentation. Returns relevant documents with summaries, scores, and navigation context. Supports filtering by product and navigation section.
FindRelatedDocs Finds documents related to a given topic or document. Useful for discovering related content and building context.
Tool Description
GetDocumentByUrl Gets a specific documentation page by its URL. Accepts a full URL or a path. Returns full document content including AI summaries and metadata.
AnalyzeDocumentStructure Analyzes the structure of a documentation page. Accepts a full URL or a path. Returns heading count, links, parents, and AI enrichment status.
Tool Description
CheckCoherence Checks documentation coherence for a given topic by finding all related documents and analyzing their coverage.
FindInconsistencies Finds potential inconsistencies in documentation by comparing documents about the same topic.

You can test the MCP server using the MCP Inspector:

npx @modelcontextprotocol/inspector --url https://www.elastic.co/docs/_mcp/

This opens a web UI where you can browse all available tools and invoke them manually.