API Documentation

🚀 MCP 专家服务器

MCP 专家服务器是一个基于模型上下文协议（Model Context Protocol）的服务器，借助 Claude AI 实现智能查询生成与文档辅助功能。它能够深入分析您的 API 文档，并提供两大实用工具，助力您高效处理信息。

🚀 快速开始

MCP 专家服务器可借助 Claude AI 对 API 文档进行分析，通过提供的工具实现智能查询生成和文档信息获取。

✨ 主要特性

• create-query：能够依据自然语言请求，精准生成查询内容。
• documentation：可根据提出的问题，快速提供相关文档信息。

📦 安装指南

先决条件

• 需要安装 Node.js 18 及以上版本。
• 准备好用于 Claude 的 Anthropic API 密钥。

安装步骤

1. 克隆仓库。
2. 安装依赖项：

npm install

3. 创建一个 .env 文件，并在其中添加您的 Anthropic API 密钥：

ANTHROPIC_API_KEY=your_api_key_here

💻 使用示例

基础用法

启动服务器

npm start

使用 create-query 工具

{
    "name": "create-query",
    "arguments": {
        "request": "查找过去一周内注册的所有用户"
    }
}

使用 documentation 工具

{
    "name": "documentation",
    // 此处可补充具体的请求参数，原文未完整给出
}

📚 详细文档

设置

在运行服务器之前，需要完成以下设置操作：

1. 构建项目并运行设置脚本：

npm run build
npm run setup

此操作会：

• 创建所需的目录（docs/ 和 prompts/）。
• 创建默认提示文件。
• 生成初始服务描述。

2. 将您的 API 文档文件添加到 docs/ 目录中（支持 .txt、.md 和 .json 文件）。
3. 可选择性地对 prompts/ 目录中的提示进行自定义：
   • system-prompt.txt：Claude 的主要系统提示。
   • tool-metadata.txt：工具描述的额外上下文。
   • query-metadata.txt：查询生成的额外上下文。
   • service-description.txt：自动生成的服务描述。