Planet Earth 是一个开源平台,旨在将人工智能开发环境(如AI IDE)与您的企业内部服务连接起来。其核心组件之一是MCP服务器,它使AI工具能够以标准化方式访问和使用您组织内部的API和文档。
主要功能点
- API发现: 索引和搜索企业内部的OpenAPI规范。
- 文档搜索: 索引和搜索内部技术文档(如手册、指南等)。
- AI工具集成: 暴露标准的MCP接口,允许兼容的AI工具(如AI IDE)发现和调用内部能力。
- 语义搜索工具: 提供基于向量搜索的工具,使AI能够理解自然语言查询,并找到相关的API端点或文档内容。
- 会话和审计: 记录搜索查询和结果。
安装步骤
本项目推荐使用Docker Compose进行快速启动:
- 克隆 Planet Earth GitHub 仓库到您的本地或服务器。
- 进入 'planet-earth/earth-service' 目录。
- 复制 '.env.example' 文件并重命名为 '.env',根据您的环境配置数据库等信息。
- 运行 'docker-compose up -d' 命令。这将启动包括MCP服务器、后端服务、数据库等在内的所有必要组件。
服务器配置 (供MCP客户端使用)
要连接兼容的MCP客户端(如AI IDE),您需要提供MCP服务器的启动命令和名称。根据默认配置,MCP服务器(位于 'earth-mcp' 目录下,使用 Bun 运行)需要通过命令启动。您可以在客户端配置以下信息:
- 服务器名称: 'Search Any API endpoint specification.'
- 启动命令 (Command): 'bun'
- 启动参数 (Args): '["run", "index.ts"]'
- 工作目录: '[planet-earth仓库根目录]/earth-mcp' (请替换为您实际的仓库路径)
- 传输协议: SSE (这是默认使用的协议)
- (可选) 服务器地址/端口: 如果您的客户端配置中需要指定地址,通常是在运行MCP客户端的同一台机器上连接,默认地址是 'http://localhost:3000/sse'。请根据您的部署环境调整。
基本使用方法
- 访问Web界面: 启动服务后,访问 Planet Earth 的 Web 界面(通常是 'http://localhost:3000')。
- 上传资源: 导航到“Schemas”或相关文档部分,上传您的OpenAPI JSON/YAML 文件或文档文件。系统将自动处理并索引它们。
- 连接AI IDE: 在您的AI IDE中找到MCP或自定义工具设置,使用上一节提供的配置信息连接到 Planet Earth MCP 服务器。
- 在IDE中使用: 连接成功后,您的AI IDE应能利用 Planet Earth 提供的工具搜索和访问您已索引的内部API和文档。
信息
分类
开发者工具