使用说明

项目简介

Atlas Docs MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，专门为大型语言模型（LLM）客户端提供技术文档服务。它旨在解决LLM在处理新兴或小众技术库时，因训练数据不足而难以正确使用的问题。该服务器通过预处理各种技术库的官方文档，并以结构化的方式提供给LLM，从而提升LLM在代码生成和技术咨询方面的准确性。

主要功能点

提供丰富的技术文档资源: 支持包括Astro、React、Vue等众多流行的库和框架的官方文档。
结构化文档: 将官方文档处理成LLM友好的Markdown格式，方便模型理解和利用。
便捷的文档访问工具: 提供一系列工具，允许LLM客户端根据需要检索、浏览和搜索文档内容。
- 'list_docs': 列出所有可用的文档库，是了解当前服务器支持哪些文档的第一步。
- 'get_docs_index': 获取文档的精简索引，帮助LLM快速了解文档结构和内容概览。
- 'get_docs_full': 获取完整的文档内容，适用于需要全面了解文档的场景。
- 'search_docs': 根据关键词在文档中搜索相关页面，快速定位所需信息。
- 'get_docs_page': 获取指定路径的文档页面内容，用于获取详细的文档信息。

安装步骤

该MCP服务器可以通过 npm 直接安装和运行，无需复杂的配置。

确保已安装 Node.js 和 npm: Atlas Docs MCP Server 是一个 Node.js 应用，需要 Node.js 运行环境。
无需安装服务器: Atlas Docs MCP Server 以 npm 包的形式提供，MCP客户端可以直接通过 'npx' 命令启动，无需手动安装到全局环境。

服务器配置

对于支持 MCP 协议的客户端（如 Cursor, Cline, Windsurf, Claude Desktop），您需要在客户端的 MCP 服务器配置文件中添加以下配置信息。这告诉客户端如何启动和连接 Atlas Docs MCP Server。

{
  "mcpServers": {
    "atlas-docs": {  // 服务器名称，客户端用此名称引用
      "command": "npx", // 启动服务器的命令，这里使用 npx 运行 npm 包
      "args": ["-y", "@cartographai/atlas-docs-mcp"] // 命令参数，-y 表示自动确认安装，@cartographai/atlas-docs-mcp 是 npm 包名
    }
  }
}

请注意:

'"atlas-docs"' 可以自定义，作为客户端引用此服务器的名称。
'"command"' 和 '"args"' 指定了如何启动 Atlas Docs MCP Server。 'npx @cartographai/atlas-docs-mcp' 命令会下载并运行 '@cartographai/atlas-docs-mcp' npm 包，启动 MCP 服务器。
部分客户端（如 Claude Desktop）可能需要重启才能识别新的 MCP 服务器配置。

基本使用方法

配置完成后，在您的LLM客户端中，您可以通过自然语言指令引导模型使用 'atlas-docs' 服务器提供的工具来查询文档。例如，您可以指示模型：

"使用 'atlas-docs' 工具来查找关于 Astro 框架的文档，并告诉我如何开始一个新项目。"

更具体的指令可以引导模型使用特定的工具，例如：

"使用 'atlas-docs' 的 'list_docs' 工具查看有哪些文档库可用。" "使用 'atlas-docs' 的 'search_docs' 工具在 Astro 文档中搜索 '组件' 相关的页面。" "使用 'atlas-docs' 的 'get_docs_page' 工具获取 Astro 文档中 '/guides/components' 页面的内容。"

提示: 为了获得最佳效果，建议在Prompt中明确指示模型使用 'atlas-docs' 服务器提供的工具来辅助完成任务，例如 "Use the tools to check the documentation for [Library Name]...".

关键词