文档服务工具

一个基于Model Context Protocol (MCP)的文档服务工具,用于组织和展示应用程序的文档内容,包括快速入门指南和代码示例。

  • by droidnext
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 droidnext/mcp_dev_docs_server

使用说明

MCP文档服务器

该项目使用模型上下文协议(MCP)为各种应用程序提供文档。它演示了如何通过MCP工具组织和公开文档内容,包括快速入门指南和代码示例。

📚 文档结构

申请文件按照 content/ 目录。对于XYZ应用程序,内容位于 content/xyz/ 包括:

  • quickstart.md:与XYZ应用程序集成的快速入门指南。
  • code_examples.md:演示如何将XYZ应用程序与MCP工具一起使用的各种代码示例。

🛠️ MCP工具

MCP工具定义见 app/mcp/mcp_routes.py 公开文档内容:

  • quickstart:提供指定应用程序的快速入门指南。
  • code_examples:提供指定应用程序的代码示例。

⚙️ 安装说明

  1. 初始化环境

    uv init
    uv venv
    source .venv/bin/activate
    uv pip install fastapi uvicorn openai fastmcp
    uvicorn app.main:app
    
  2. 启动应用服务器

    运行提供的启动脚本:

    chmod +x scripts/start.sh
    ./scripts/start.sh
    

使用Claude Desktop连接到MCP服务器

要将Claude Desktop连接到此MCP文档服务器,您需要在Claude的设置中添加新的服务器配置。

  1. 打开克劳德桌面设置。
  2. 导航到“开发人员”部分。
  3. 在“MCP服务器配置”下,添加以下JSON配置:
{
  "AppDocsServer": {
    "command": "npx",
    "args": [
      "mcp-remote",
      "http://localhost:8000/mcp-app-docs-server/mcp"
    ]
  }
}
  1. 保存设置。Claude Desktop现在应该能够发现和使用此服务器提供的工具。

运行MCP检查器

要测试和检查此服务器公开的MCP工具,您可以使用MCP检查器工具。在终端中运行以下命令:

npx @modelcontextprotocol/inspector node build/index.js

这将启动检查器,允许您与 quickstart 和 code_examples 此服务器提供的工具。