Public Apis Mcp

Public APIs MCP Server

English | 中文

一个 Model Context Protocol（MCP）服务，为 public-apis 数据库提供智能访问和管理功能。

🚀 项目概览

Public APIs MCP Server 是一款专业的 MCP 服务实现，旨在为开发者提供便捷的公共 API 发现、搜索和集成服务。借助标准化的 MCP 协议，你可以轻松将丰富的公共 API 资源集成到各种 AI 助手和开发工具中。

核心功能

• 🔍 智能搜索：按类别、关键词、身份验证方式等多个维度搜索 API。
• 🛡️ 安全筛选：根据 HTTPS 支持、CORS 配置等进行安全筛选。
• 🎯 智能推荐：根据项目需求智能推荐最合适的 API。
• 💻 代码生成：自动生成多种编程语言的 API 集成代码。
• 📊 统计分析：提供详细的 API 数据统计和分析。
• 🔄 实时同步：支持从 GitHub 仓库同步最新的 API 数据。

📸 预览

📦 安装

环境要求

• Node.js >= 18.0.0
• npm >= 8.0.0

快速安装

# Clone the project
git clone https://github.com/worryzyy/public-apis-mcp.git
cd public-apis-mcp

# Install dependencies
npm install

# Build the project
npm run build

# Start the server
npm start

开发模式

# Start in development mode (with hot reload)
npm run dev

🛠️ 用法

基本配置

服务启动后，将通过标准输入/输出与 MCP 客户端通信。你可以在支持 MCP 协议的 AI 助手或开发工具中配置此服务。

MCP 客户端配置示例

{
  "mcpServers": {
    "public-apis-mcp": {
      "command": "node",
      "args": ["path/to/public-apis-mcp/dist/index.js"]
    }
  }
}

或者

{
  "mcpServers": {
    "public-apis-mcp": {
      "command": "npx",
      "args": ["-y", "@weilei_kyle/public-apis-mcp"]
    }
  }
}

🔧 可用工具

API 搜索与发现

search_apis_by_category

按类别搜索 API

参数：

• category（string，必需）：API 类别名称
• limit（number，可选）：限制返回结果数量，默认为 10

示例：

{
  "category": "Weather",
  "limit": 5
}

search_apis_by_keyword

按关键词搜索 API

参数：

• keyword（string，必需）：搜索关键词
• limit（number，可选）：限制返回结果数量，默认为 10

filter_apis_by_auth

按身份验证要求筛选 API

参数：

• authType（string，必需）：身份验证类型（No、apiKey、OAuth、X-Mashape-Key、User-Agent）
• limit（number，可选）：限制返回结果数量，默认为 10

filter_apis_by_https

筛选支持 HTTPS 的 API

参数：

• httpsOnly（boolean，可选）：是否仅返回支持 HTTPS 的 API，默认为 true
• limit（number，可选）：限制返回结果数量，默认为 10

filter_apis_by_cors

筛选支持跨域访问的 API

参数：

• corsSupport（string，必需）：CORS 支持状态（yes、no、unknown）
• limit（number，可选）：限制返回结果数量，默认为 10

API 详情与统计

get_api_details

获取特定 API 的详细信息

参数：

• apiName（string，必需）：API 名称

get_category_list

获取所有可用 API 类别的列表

get_random_api

随机推荐一个 API

参数：

• category（string，可选）：将随机选择范围限定在特定类别内

get_api_statistics

获取 API 数量统计信息

analyze_auth_requirements

分析不同身份验证方式下 API 的分布情况

智能推荐

recommend_apis_for_project

根据项目需求推荐合适的 API

参数：

• projectType（string，必需）：项目类型描述
• requirements（array，可选）：项目需求列表
• limit（number，可选）：限制推荐的 API 数量，默认为 5

find_alternative_apis

查找可替代的 API 选项

参数：

• functionality（字符串，必填）：所需功能的描述
• limit（数字，可选）：限制返回结果的数量，默认值为 5

代码生成

generate_api_integration_code

为选定的 API 生成集成代码示例

参数：

• apiName（字符串，必填）：API 名称
• language（字符串，可选）：编程语言（javascript、python、curl），默认值为 javascript

数据管理

sync_repository_data

从 GitHub 仓库同步最新的 API 列表

重要提示：此接口目前采用手动同步机制，将 public-apis 仓库中的最新数据同步到本地服务器，主要用于确保数据稳定性和访问速度。

工作原理：

• 手动触发，从 GitHub 仓库获取最新的 API 数据
• 将数据缓存到本地服务器，以提升查询性能
• 支持增量更新和强制全量同步模式
• 完成后返回详细的同步状态报告

参数：

• force（布尔值，可选）：是否强制重新同步，默认值为 false
  • false：仅在数据过期时执行增量同步
  • true：忽略本地缓存，强制全量同步数据

使用建议：

• 建议首次使用前执行强制同步（force: true）
• 日常使用期间定期执行增量同步，以获取最新数据
• 如果发现数据异常，可使用强制同步重置本地缓存

check_new_apis

检查近期新增的 API

参数：

• days（数字，可选）：检查最近几天新增的 API，默认值为 7 天

📁 项目结构

public-apis-mcp/
├── src/
│   ├── index.ts                    # Main entry file
│   ├── server/
│   │   └── server.ts              # MCP server implementation
│   ├── services/
│   │   ├── api-service.ts         # API data management service
│   │   ├── search-service.ts      # Search functionality service
│   │   ├── tool-service.ts        # Tool call handling service
│   │   ├── code-generation-service.ts  # Code generation service
│   │   ├── recommendation-service.ts   # Recommendation algorithm service
│   │   └── formatter-service.ts   # Data formatting service
│   └── types/
│       └── api.ts                 # TypeScript type definitions
├── dist/                          # Compilation output directory
├── package.json                   # Project configuration
├── tsconfig.json                  # TypeScript configuration
└── README.md                      # Project documentation

🔧 开发

技术栈

• TypeScript：类型安全的 JavaScript 超集
• Node.js：JavaScript 运行时环境
• MCP SDK：Model Context Protocol 软件开发套件
• Axios：HTTP 客户端库
• Zod：TypeScript 优先的架构验证库

构建与测试

# Compile TypeScript
npm run build

# Run tests
npm test

# Development mode (hot reload)
npm run dev

代码规范

本项目遵循以下开发规范：

• 使用 TypeScript 进行类型安全开发
• 采用模块化架构设计
• 完善的错误处理机制
• 详尽的代码注释和文档

🤝 贡献

欢迎提交 Issue 和 Pull Request，帮助改进本项目！

贡献流程

1. Fork 此仓库
2. 创建功能分支（git checkout -b feature/AmazingFeature）
3. 提交更改（git commit -m 'Add some AmazingFeature'）
4. 推送到分支（git push origin feature/AmazingFeature）
5. 创建 Pull Request

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。

🙏 致谢

• public-apis - 提供丰富的公共 API 数据源

📞 联系方式

如有问题或建议，请通过以下方式联系我们：

• 提交 GitHub Issue

---

注意：本项目仍在积极开发中，API 可能会发生变化。建议在用于生产环境前进行充分测试。