article
README
🚀 Kanta MCP 服务器
Kanta MCP 服务器是一个基于 Model Context Protocol(MCP)的服务器,专为 Kanta API 设计,可实现与 Claude 等语言模型的集成,为用户提供便捷、高效的 API 服务。
🚀 快速开始
Kanta MCP 服务器通过 MCP 协议公开 Kanta API v1.1 的功能,使 AI 助手能够与 Kanta 数据进行交互,主要用于以下场景:
- 管理客户(创建、更新、搜索、分配)
- 管理用户
- 查看人员数据
- 获取公司和机构的信息
- 获取风险摘要
✨ 主要特性
客户管理
get_customers:分页列出客户get_customer:通过 ID 获取客户create_customer:创建新客户update_customer:更新现有客户search_customers:搜索客户assign_customers:分配监管人员/贡献者get_customer_risk_summary:获取风险摘要
用户管理
get_users:列出用户get_user:通过 ID 获取用户create_user:创建新用户delete_user:删除用户
人员管理
get_persons:列出人员get_person:通过 ID 获取人员
其他功能
get_firms:列出公司get_structure:获取结构信息
📦 安装指南
通过 Smithery 安装
要通过 Smithery 自动为 Claude Desktop 安装 kanta-mcp-server,请运行以下命令:
npx -y @smithery/cli install @Kanta-Inc/kanta-mcp-server --client claude
手动安装
- 克隆仓库:
git clone <repository-url>
cd kanta-mcp-server
- 安装依赖:
npm install
- 编译 TypeScript:
npm run build
📚 详细文档
环境变量要求
KANTA_API_KEY:您的 Kanta API 密钥(必需)KANTA_API_URL:API 的基本 URL(可选,默认值:https://app.kanta.fr/api/v1)
获取 API 密钥
要获取您的 Kanta API 密钥,请按以下步骤操作:
- 登录到 https://app.kanta.fr
- 进入“公司管理”
- 选择“API 密钥”
- 生成或复制您的 API 密钥
💻 使用示例
启动服务器
# 使用 npm
KANTA_API_KEY=your_api_key npm start
# 或者在开发环境中使用 tsx
KANTA_API_KEY=your_api_key npm run dev
MCP 配置
将以下配置添加到您的 MCP 客户端(如 Claude Desktop):
{
"mcpServers": {
"kanta": {
"command": "node",
"args": ["/chemin/vers/kanta-mcp-server/dist/index.js"],
"env": {
"KANTA_API_KEY": "votre_cle_api_ici"
}
}
}
}
🔧 技术细节
可用脚本
npm run build:编译 TypeScriptnpm start:启动编译后的服务器npm run dev:使用 tsx 以开发模式启动npm run watch:以监听模式启动以进行开发
项目结构
src/
├── index.ts # 主入口点
├── types.ts # 类型定义和 Zod 模式
├── kanta-client.ts # Kanta API 的 HTTP 客户端
└── tools/
├── customers.ts # 客户管理工具
├── users.ts # 用户管理工具
├── persons.ts # 人员管理工具
└── misc.ts # 其他工具(公司、结构、文件)
Kanta API
本服务器使用 Kanta API v1.1。有关 API 的更多信息:
- 基本 URL:https://app.kanta.fr/api/v1
- 身份验证:通过
X-API-Key头部的 API 密钥 - 完整文档可在
api-docs.json文件中找到
⚠️ 局限性
- 文件上传/下载功能不可用(MCP 限制)
- 所有操作都需要有效的 Kanta API 密钥
- 主要专注于 CRUD 操作和 JSON 数据查询
📄 许可证
本项目采用 MIT 许可证。
🛠️ 支持
- 有关 Kanta API 的问题,请查阅 Kanta 官方文档。
- 有关此 MCP 服务器的问题,请在此仓库中创建一个 issue。
微信扫一扫