Api Market MCP Server

🚀 API-MCP 服务器

API-MCP 服务器是一个强大的工具，它允许你集成和管理各种 API。通过简单的安装和配置步骤，你可以快速启动并运行该服务器，还能根据需求进行开发和扩展。

🚀 快速开始

要安装并运行 API-MCP 服务器，请按照以下步骤操作：

使用 npm 安装

npm install -g @magicapi/mcp-server

启动服务器

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

示例命令

示例 1：使用默认配置运行

mcp-server

示例 2：指定 API 基础 URL 和密钥

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

📦 安装指南

要安装 API-MCP 服务器，可使用 npm 进行全局安装：

npm install -g @magicapi/mcp-server

安装完成后，可使用以下命令启动服务器：

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

💻 使用示例

基础用法

以下是使用默认配置运行服务器的示例：

mcp-server

高级用法

指定 API 基础 URL 和密钥来运行服务器：

mcp-server --api-base-url https://api.magicapi.dev/api/v1/ --headers "x-magicapi-key:your-api-key"

📚 详细文档

开发

添加新 API 到 MCP 服务器

步骤 1：定位 OpenAPI 规范

找到你想要集成的 API 的 OpenAPI JSON 文件。然后，在项目根目录下创建一个名为 json_files 的文件夹，并将你的 OpenAPI JSON 文件添加到该文件夹中。

步骤 2：修改 OpenAPI 规范

在获取到 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：提交你的更改

如果你希望将这些更改贡献到仓库：

• 叉出仓库。
• 创建一个功能分支。
• 提交你的更改。
• 提交一个拉取请求（PR）。

步骤 6：发布 MCP 服务器（可选）

如果你希望发布你的更改：

• 更新 package.json 文件（例如，更新版本、名称等）。
• 发布包：

  npm publish --access public
  

开发工具

构建

• npm run build - 构建 TypeScript 源代码。
• npm run clean - 删除构建 artifacts。
• npm run typecheck - 运行 TypeScript 类型检查。

开发模式

• npm run dev - 监视源文件并在发生更改时重新构建。
• npm run inspect-watch - 运行带自动重载的 inspector。

代码质量

• npm run lint - 运行 ESLint。
• npm run typecheck - 验证 TypeScript 类型。

设置环境变量：

通过运行以下命令配置你的环境：

export OPENAPI_SPEC_PATH=modified_files.txt # 可选
export API_BASE_URL=https://api.magicapi.dev/api/v1/ # 可选
export NODE_OPTIONS=--loader ts-node/esm # 可选

贡献指南

提交代码

在提交代码之前，请确保运行以下命令：

npm run lint
npm test

然后，提交你的更改并创建一个拉取请求。

调试或本地运行

安装依赖项

npm install

启动开发服务器

npm run dev

访问文档

访问 文档 查看更多详细信息。

通过以上步骤，你可以轻松地安装、配置和使用 API-MCP 服务器，并根据需要进行扩展和自定义。