Integrates with RAP2 API documentation platform, allowing AI assistants to access, search, and retrieve API interface documentation, manage repository interfaces, and query API specifications from RAP2 instances.
RAP2 MCP Server - API Documentation for LLMs and AI Code Editors
RAP2 MCP Server - 将 RAP2 API 文档和接口管理能力无缝集成到 AI 编程助手中,让 LLM 能够直接访问和操作 RAP2 接口文档。
⚡ 快速开始
方式一:直接使用 npx(推荐,无需安装)
方式二:在 AI 编程助手中集成(最推荐)
直接在您的 AI 编程助手(如 Cursor、Claude Desktop)中配置 MCP 服务器,无需手动启动:
配置完成后,AI 助手将自动启动 RAP2 MCP 服务器,您可以直接在对话中使用 RAP2 接口文档功能。
🚀 特性
🔗 无缝集成 - 标准 MCP 协议,支持所有主流 AI 编程助手
📚 接口文档访问 - 直接获取 RAP2 接口详情和文档
🔍 智能搜索 - 按关键字搜索接口,支持跨仓库查询
🔐 灵活认证 - 支持账号密码和 Cookie 两种认证方式
📊 结构化日志 - 完整的请求日志记录,便于调试和监控
⚡ 高性能 - 基于 undici 的高性能 HTTP 客户端
🛡️ 安全可靠 - 支持多种认证方式,确保数据安全
🎯 精准匹配 - 智能接口搜索,快速定位所需 API
🔄 实时同步 - 与 RAP2 实例实时同步,确保数据最新
📱 跨平台 - 支持 Windows、macOS、Linux 等主流操作系统
🔧 易于配置 - 简单的环境变量配置,快速上手
📈 可扩展 - 模块化设计,易于扩展新功能
📦 安装方式
推荐方式:使用 npx(无需安装)
可选方式:全局安装
如果您需要频繁使用命令行工具,可以选择全局安装:
开发方式:从源码安装
⚙️ 配置
环境变量
变量名 | 必需 | 描述 | 示例 |
| ✅ | RAP2 实例地址 |
|
| 🔄 | 登录邮箱(与密码配对使用) |
|
| 🔄 | 登录密码(与邮箱配对使用) |
|
| 🔄 | 已登录的 Cookie SID |
值 |
| 🔄 | 已登录的 Cookie 签名 |
值 |
认证方式说明:支持两种认证方式,二选一即可:
账号密码:使用
RAP2_EMAIL+RAP2_PASSWORDCookie 认证:使用
RAP2_SID+RAP2_SID_SIG
手动启动服务器(可选)
如果您需要手动启动服务器进行测试或调试:
使用账号密码认证
使用 Cookie 认证
🔧 与 AI 编程助手集成
🎯 这是最推荐的使用方式! 直接在 AI 编程助手中集成,无需手动启动服务器。
通用配置模板(推荐)
Cursor 配置
在 Cursor 的 MCP 配置中添加:
Claude Desktop 配置
在 Claude Desktop 的配置文件中添加:
其他 MCP 客户端
任何支持 MCP 协议的客户端都可以使用此服务器,只需配置相应的启动命令和环境变量。
推荐配置(npx 方式,无需安装)
可选配置(全局安装方式)
🛠️ 可用工具
RAP2 MCP Server 提供以下工具供 LLM 使用:
rap2_test_connection
测试与 RAP2 服务器的连接状态
功能:探测服务器连通性,必要时自动登录
用途:验证配置和网络连接
rap2_ensure_session
确保有效的登录会话
功能:使用环境变量登录并保存 Cookie 到会话缓存
用途:建立和维护认证状态
rap2_debug_login_info
输出当前登录配置摘要
功能:显示登录配置信息(不包含明文密码)
用途:调试和验证配置
rap2_get_interface_by_id
通过接口 ID 获取接口详情
参数:
interfaceId(必需) - RAP2 中的接口 ID返回:接口的详细信息,包括 URL、方法、参数和响应数据结构
rap2_get_repository_interfaces
获取指定仓库中的所有接口列表
参数:
repositoryId(必需) - RAP2 中的仓库 ID返回:仓库中的所有接口列表
rap2_search_interfaces_by_keyword
通过关键字搜索接口
参数:
keyword(必需) - 搜索关键字repositoryId(可选) - 限制搜索范围的仓库 ID
返回:匹配的接口列表
rap2_search_interfaces_by_path
通过请求路径搜索接口
参数:
path(必需) - 请求路径(如:/api/users)repositoryId(可选) - 限制搜索范围的仓库 ID
返回:匹配的接口列表
📝 使用示例
在 AI 对话中使用(自然语言触发)
获取特定接口详情
📊 日志和监控
日志文件位置
路径:
/tmp/rap-mcp.log格式:结构化 JSON 日志
内容:服务器请求、响应、错误信息
查看日志
🔧 开发
本地开发
项目结构
测试
🚨 故障排除
常见问题
1. 连接失败或未登录自动跳转HTML
检查
RAP2_BASE_URL是否正确确认网络连接正常
验证 RAP2 服务器是否可访问
已内置自动登录重试:若遇到 401/403 或返回 HTML 登录页,客户端会尝试一次自动登录并重试请求
2. 认证失败
确认邮箱和密码正确
检查 Cookie 是否过期
验证 RAP2 实例是否支持当前认证方式
可在对话中先说“确保已登录”触发
rap2_ensure_session
3. 模块未找到错误
4. 权限问题
📋 系统要求
🟢 Node.js: >= 18.0.0
💻 操作系统: Windows, macOS, Linux
🧠 内存: 最少 128MB
🌐 网络: 需要访问 RAP2 实例的网络连接
📦 包管理器: npm, pnpm, yarn
🔧 开发工具: 支持 MCP 协议的 AI 编程助手
📄 许可证
本项目采用 MIT 许可证。
🤝 贡献
欢迎贡献代码!请遵循以下步骤:
🍴 Fork 本仓库 - 创建您的项目副本
🌿 创建特性分支 (
git checkout -b feature/AmazingFeature) - 为您的功能创建分支💾 提交更改 (
git commit -m 'Add some AmazingFeature') - 提交您的改进📤 推送到分支 (
git push origin feature/AmazingFeature) - 推送您的更改🔄 开启 Pull Request - 创建合并请求
贡献类型
🐛 Bug 修复 - 修复现有问题
✨ 新功能 - 添加新特性
📚 文档改进 - 完善文档
🎨 代码优化 - 提升代码质量
🧪 测试用例 - 增加测试覆盖
📞 支持
如果您遇到问题或有建议,请:
🐛 提交 - 报告 Bug 或提出功能请求
📖 查看 - 详细文档和教程
💬 联系维护者 - 直接沟通和技术支持
⭐ 给项目点赞 - 支持项目发展
🍴 Fork 项目 - 参与开源贡献
📝 提交 PR - 贡献代码改进
⭐ Star History
如果这个项目对您有帮助,请给我们一个 ⭐!
RAP2 MCP Server - 让 AI 编程助手更智能地处理 API 文档!