API Documentation

🚀 MCP 专家服务器

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

• create-query：依据自然语言请求生成查询。
• documentation：根据问题提供相关文档信息。

🚀 快速开始

MCP 专家服务器的使用需要满足一定的先决条件，完成安装、设置等步骤，下面为您详细介绍。

✨ 主要特性

• 利用 Claude AI 提供智能查询生成和文档辅助功能。
• 提供 create-query 和 documentation 两个实用工具。
• 支持多种 API 文档文件格式，包括 .txt、.md 和 .json。

📦 安装指南

先决条件

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

安装步骤

1. 克隆仓库。
2. 安装依赖项，执行以下命令：

npm install

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

ANTHROPIC_API_KEY=your_api_key_here

🔧 设置

在运行服务器之前，请按以下步骤进行设置：

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：自动生成的服务描述。

💻 使用示例

独立服务器

启动服务器，执行以下命令：

npm start

该服务器通过 Model Context Protocol 提供两个工具：

基础用法

• create-query：根据自然语言请求生成查询。

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

• documentation：从文档中获取信息。

{
    "name": "documentation",
    // 这里原文档未完整给出内容，保持原样
}