Api.market

🚀 API-MCP 服务器开发指南

本指南详细介绍了 API-MCP 服务器的安装、配置、使用示例、开发流程等内容，帮助开发者快速上手并进行二次开发。

🚀 快速开始

安装依赖

克隆仓库并安装所需包，然后启动开发环境：

git clone https://github.com/Noveum/api-market-mcp-server.git
cd api-market-mcp-server
npm install
npm run dev

配置说明

必要配置项

可选配置项

💻 使用示例

基础用法

本服务器提供了多种实用功能，以下是一些使用示例：

• 示例 1：使用代理查找任意两点之间的路线

• 示例 2：使用代理查找任何主题的新闻，然后深入研究相关文章

• 示例 3：使用代理查找可用域名

📚 详细文档

添加新 API 到 MCP 服务器

utils 文件夹包含管理 API 配置、解析 OpenAPI 规范和注册新 API 的辅助脚本。具体步骤如下：

1. 获取 OpenAPI 规范：找到要集成的 API 的 OpenAPI JSON 文件。在项目根目录中创建一个名为 json_files 的文件夹，并将获取到的 OpenAPI JSON 文件放入其中。
2. 修改 OpenAPI 规范：使用 modify_api.py 脚本更新规范中的路径，使其包含文件名：

python utils/modify_api.py

3. 更新 API 概要：在修改路径后，更新 API 概要。可以选择以下两种方式之一：
   • 自动缩短概要（使用 LLM）：

python utils/LLM_summary_shortener.py 

- **手动更新概要**：

python utils/manual_summary_shortener.py 

4. 构建与测试：重建项目以应用更改：

npm run build

然后使用以下命令测试新 API 集成：

npm run inspect

5. 提交代码变更：如果希望将新 API 贡献到仓库中，需要叉叉 repo，创建功能分支，提交更改并生成拉取请求（PR）。
6. 发布 MCP 服务器（可选）：如果要发布更改，需要更新 package.json 文件（例如：更新版本号、名称等），然后发布包：

npm publish --access public

命令行参数

启动命令

npm run start

配置文件路径

通过在 package.json 中添加以下配置启动 MCP 服务器：

"scripts": {
  "start": "mcp-server --apiBaseUrl https://your_api_base_url --openapiSpec ./specs"
}

调试信息

打印日志

可以通过控制台查看实时日志：

npm run start

🤝 贡献指南

• 问题反馈：提交 issue 到 Issues 页面
• 代码贡献：提交拉取请求到 GitHub 仓库

⚠️ 重要提示

⚠️ 重要提示

所有代码示例和命令行语句均为 UTF-8 编码，请确保在支持 UTF-8 的环境中运行。