MCP server
docs-builder includes an MCP (Model Context Protocol) server that allows AI assistants to interact with the documentation tooling directly.
The MCP server currently exposes the following tools:
| 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. |
To use the docs-builder MCP server, add it to your IDE's MCP configuration.
Create or edit .cursor/mcp.json in your workspace:
{
"mcpServers": {
"docs-builder": {
"command": "docs-builder",
"args": ["mcp"]
}
}
}
Then restart Cursor or reload the window. The tools will be available in Agent mode.
Create or edit .vscode/mcp.json in your workspace:
{
"servers": {
"docs-builder": {
"type": "stdio",
"command": "docs-builder",
"args": ["mcp"]
}
}
}
Requires GitHub Copilot with MCP support enabled.
You can test the MCP server using the MCP Inspector:
npx @modelcontextprotocol/inspector docs-builder mcp
This opens a web UI where you can browse all available tools and invoke them manually.