io.github.mapbox/mcp-docs-server

السجل الرسمي الإنتاجية

AI access to Mapbox docs, API references, style specs, and guides. No token required.

ماذا يمكنك أن تفعل مع io.github.mapbox/mcp-docs-server؟

  • "What Mapbox APIs are available?"
  • "How do I add a custom layer to a Mapbox style?"
  • "What's the latest Mapbox GL JS version?"
  • "Find docs about camera animation"
  • "Search for geocoding API examples"
  • "What documentation exists for custom layers?"

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

Remote (streamable-http)
Claude Code
claude mcp add --transport http mcp-docs-server 'https://mcp-docs.mapbox.com/mcp'
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "mcp-docs-server": {
            "type": "http",
            "url": "https://mcp-docs.mapbox.com/mcp"
        }
    }
}
NPM package @mapbox/mcp-docs-server
Claude Code
claude mcp add mcp-docs-server -- npx -y @mapbox/mcp-docs-server@0.3.1
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "mcp-docs-server": {
            "command": "npx",
            "args": [
                "-y",
                "@mapbox/mcp-docs-server@0.3.1"
            ]
        }
    }
}

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. Mapbox MCP Documentation Server
  2. Quick Start
  3. Tools
  4. Resources
  5. Development
  6. Contributing
  7. License

Mapbox MCP Documentation Server

A Model Context Protocol (MCP) server that gives AI assistants instant access to Mapbox documentation and reference materials — no Mapbox access token required.

Quick Start

Hosted (no install required)

Connect directly to the hosted endpoint — nothing to install or maintain:

Claude Code / Claude Desktop / Cursor / VS Code

{
  "mcpServers": {
    "mapbox-docs": {
      "url": "https://mcp-docs.mapbox.com/mcp"
    }
  }
}

npx (runs locally, no install)

Claude Code — run claude mcp add:

claude mcp add mapbox-docs -- npx -y @mapbox/mcp-docs-server

Claude Desktop — add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "mapbox-docs": {
      "command": "npx",
      "args": ["-y", "@mapbox/mcp-docs-server"]
    }
  }
}

Cursor / VS Code — add the same mcpServers block to your editor's MCP settings file.


Docker

Build the image:

docker build -t mapbox/mcp-docs-server .

Or pull from the registry:

docker pull mapbox/mcp-docs-server

Claude Desktop / Cursor / VS Code — configure your MCP client to run the container:

{
  "mcpServers": {
    "mapbox-docs": {
      "command": "docker",
      "args": ["run", "--rm", "-i", "mapbox/mcp-docs-server"]
    }
  }
}

Local (from source)
git clone https://github.com/mapbox/mcp-docs-server.git
cd mcp-docs-server
npm install
npm run build

Claude Desktop / Cursor / VS Code:

{
  "mcpServers": {
    "mapbox-docs": {
      "command": "node",
      "args": ["/absolute/path/to/mcp-docs-server/dist/esm/index.js"]
    }
  }
}

Tools

get_document_tool — Fetches the full content of a specific Mapbox documentation page by URL. Use this to follow a link from a resource and retrieve the complete page content.

Example prompts:

  • "What Mapbox APIs are available?"
  • "How do I add a custom layer to a Mapbox style?"
  • "What's the latest Mapbox GL JS version?"

batch_get_documents_tool — Fetches multiple Mapbox documentation pages in a single call (max 20). More efficient than calling get_document_tool multiple times. Failed pages include an error message rather than failing the whole batch.

search_mapbox_docs_tool — Searches Mapbox documentation across API reference, GL JS, Help Center, Style Spec, Studio, Search JS, iOS/Android Maps and Navigation SDKs, and Tilesets, returning ranked page URLs and descriptions. Use this to find relevant documentation before fetching full pages with get_document_tool or batch_get_documents_tool.

Example prompts:

  • "Find docs about camera animation"
  • "Search for geocoding API examples"
  • "What documentation exists for custom layers?"

Resources

MCP resources expose reference data that AI assistants can read on demand:

Resource URIContents
resource://mapbox-api-referenceREST API reference docs (endpoints, parameters, rate limits)
resource://mapbox-sdk-docsSDK and client library docs (iOS, Android, Flutter, web)
resource://mapbox-guidesTutorials, how-tos, and guides
resource://mapbox-examplesCode examples, API playgrounds, and interactive demos
resource://mapbox-referenceTilesets, data products, accounts, and pricing reference
resource://mapbox-style-layersStyle layer reference (paint/layout properties for all layer types)
resource://mapbox-streets-v8-fieldsMapbox Streets v8 tileset field reference
resource://mapbox-token-scopesAll available Mapbox token scopes with descriptions
resource://mapbox-layer-type-mappingMapping of Mapbox layer types to their properties

Development

Prerequisites
  • Node.js >= 22
  • npm
Setup
git clone https://github.com/mapbox/mcp-docs-server.git
cd mcp-docs-server
npm install
Commands
npm run build          # Compile TypeScript (ESM + CJS)
npm test               # Run test suite (vitest)
npm run lint           # ESLint
npm run format         # Prettier check
npm run format:fix     # Prettier auto-fix
npm run inspect:build  # Launch MCP Inspector against built server
npm run inspect:dev    # Launch MCP Inspector against source (tsx)
Architecture

The server is a TypeScript MCP server using @modelcontextprotocol/sdk with a dual ESM/CJS build via tshy.

  • Tools extend BaseTool<InputSchema, OutputSchema> in src/tools/
  • Resources extend BaseResource in src/resources/
  • No Mapbox access token required for documentation tools
  • HTTP requests use a shared httpPipeline with 1-hour caching
Creating a New Tool
  1. Create a directory src/tools/my-tool/
  2. Add MyTool.input.schema.ts (Zod schema), MyTool.output.schema.ts, and MyTool.ts (extends BaseTool)
  3. Register in src/tools/toolRegistry.ts
  4. Add tests in test/tools/my-tool/

Contributing

Please read CONTRIBUTING.md and VISION.md before submitting a pull request. Contributors using AI coding assistants should also review:

  • CLAUDE.md — for Claude Code
  • AGENTS.md — for other AI coding assistants (Cursor, Copilot, Aider, etc.)

License

MIT — see LICENSE

الأسئلة الشائعة

ما هو io.github.mapbox/mcp-docs-server؟

AI access to Mapbox docs, API references, style specs, and guides. No token required.

كيف أثبّت io.github.mapbox/mcp-docs-server؟

يعمل كخادم بعيد. في Claude Code: claude mcp add --transport http mcp-docs-server 'https://mcp-docs.mapbox.com/mcp'. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.mapbox/mcp-docs-server إلى مفتاح API؟

لا يذكر إدراجه في السجل أي مفتاح أو سر إلزامي. قد تتطلب بعض الميزات حسابًا لدى الخدمة التي يتصل بها.

هل io.github.mapbox/mcp-docs-server مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.mapbox/mcp-docs-server؟

ينشره mapbox. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.