Kodus MCP Manager
使用说明(简明版,便于快速上手):
- 项目简介
- 这是一套基于 NestJS 的服务端应用,面向 MCP 客户端提供资源、工具、提示模板等上下文服务,并支持多家提供商的集成与管理。通过 PostgreSQL 数据库持久化数据,提供 REST 风格的 API 来管理 MCP 连接、集成、工具以及 OAuth 流程。
- 主要功能点
- 支持多提供商架构(如 Composio、KodusMCP、Custom 提供者),实现对集成、工具、参数、连接等的管理。
- 提供 MCP 相关实体(集成、OAuth、连接等)的创建、查询、更新与删除等完整业务流程。
- 支持 OAuth2 授权流程的自动化管理(包括状态、Token 刷新与存储加密)。
- 提供完整的数据库迁移脚本、测试用例以及 API 文档入口(Swagger/OpenAPI)。
- 提供对外 REST API,方便 MCP 客户端查询 Integrations、Initiate Connection、Get Connections 等。
- 具备安全性与错误处理(全局异常过滤、基本鉴权、IP/鉴权控制及 API 文档保护等)。
- 安装步骤
-
- 克隆仓库并进入项目目录。
-
- 安装依赖(如 yarn install)。
-
- 启动 PostgreSQL 数据库(可使用 Docker Compose 按需部署)。
-
- 配置环境变量(如数据库连接、提供商配置、JWT、OpenAPI 访问等)。
-
- 运行数据库迁移以创建 schema 与表结构(如 yarn migrate)。
-
- 启动应用(开发模式 yarn start:dev,生产模式 yarn start:prod;也可使用 Docker Compose)。
-
- Swagger 文档默认开启时可通过 /docs 访问 API 说明(需满足开启文档的条件)。
-
- 服务器配置(MCP 客户端与服务器的对接信息)
以下为示例配置,适用于将服务器暴露给 MCP 客户端使用。配置信息以 JSON 形式给出,包含服务器名称、启动命令及参数等信息,帮助 MCP 客户端正确启动并连接到 MCP 服务器。请注意,实际生产环境请将命令和参数按实际运行环境调整。
{
"serverName": "kodus-mcp-manager",
"command": "yarn start:prod",
"args": [
"--port=3101",
"--env=production"
],
"notes": "此配置用于客户端连接服务器,确保服务端已正确通过数据库连接并对外暴露 API。若使用容器化部署,请在容器编排中注入相应环境变量并暴露端口。"
}
说明:
- serverName:服务器在 MCP 客户端中的标识名称,需与实际部署一致。
- command:启动服务器的命令,一般为生产模式启动命令。
- args:启动命令的参数(如端口、环境等)。
- 客户端无需额外代码即可读取此配置信息来建立连接,但具体连接方式以 MCP 客户端实现为准。
- 基本使用方法
- 启动后,服务器将提供 MCP 相关 API:获取集成、获取集成详情、发起连接、查看与管理连接等。
- 客户端在获取集成列表后,可以根据需要创建连接、查询工具、管理已连接的工具集合等。
- 如需使用 OAuth2、Kodus 管理的集成等高级场景,请参考集成服务中的相关流程(如 OAuth 初始化、终结、状态管理等)。