Torna MCP Server
一个用于与 Torna 接口文档管理平台交互的 MCP(模型上下文协议)服务器。该服务器提供了工具,允许 LLM 通过标准化的接口来管理 Torna 中的文档、字典和模块。
功能特性
文档 API (Doc API)
推送文档 (
torna_push_document) - 向 Torna 推送 API 文档创建分类 (
torna_create_category) - 创建文档分类/文件夹更新分类名称 (
torna_update_category_name) - 更新现有分类名称列出文档 (
torna_list_documents) - 获取应用文档列表获取文档详情 (
torna_get_document_detail) - 获取单个文档详细信息批量获取文档详情 (
torna_get_document_details_batch) - 批量获取多个文档详细信息
字典 API (Dictionary API)
创建字典 (
torna_create_dictionary) - 创建新的枚举字典更新字典 (
torna_update_dictionary) - 更新现有字典信息列出字典 (
torna_list_dictionaries) - 获取字典列表获取字典详情 (
torna_get_dictionary_detail) - 获取字典详细信息删除字典 (
torna_delete_dictionary) - 删除字典(破坏性操作)
模块 API (Module API)
创建模块 (
torna_create_module) - 创建新的模块更新模块 (
torna_update_module) - 更新现有模块信息列出模块 (
torna_list_modules) - 获取模块列表获取模块详情 (
torna_get_module_detail) - 获取模块详细信息删除模块 (
torna_delete_module) - 删除模块(破坏性操作)
环境要求
Python 环境
Python 3.8 或更高版本
必要的依赖包(见 requirements.txt)
Torna 私有化部署
可访问的 Torna 服务器地址
模块访问令牌(access_token)
安装和使用
1. 安装依赖
2. 配置环境变量
需要设置以下环境变量:
其中:
TORNA_URL: Torna 私有化部署的 API 地址TORNA_TOKENS: 逗号分隔的模块令牌列表
3. 运行 MCP 服务器
服务器将启动并通过 stdio 等待 MCP 客户端连接。
4. 在 MCP 客户端中使用
将 python main.py 作为 MCP 服务器添加到你的 MCP 客户端配置中。
工具使用示例
推送文档示例
创建分类示例
创建字典示例
响应格式
所有工具都支持两种响应格式:
Markdown 格式 (默认): 人类可读,适合展示给用户
JSON 格式: 机器可读,适合程序处理
错误处理
服务器提供了一致的错误处理机制:
输入验证错误: 通过 Pydantic 模型自动处理
API 访问错误: 返回格式化的错误消息
网络错误: 处理超时和连接问题
权限错误: 检查访问令牌的有效性
安全注意事项
环境变量安全: 确保不要在代码中硬编码访问令牌
网络通信: 建议使用 HTTPS 连接到 Torna 服务器
权限控制: 确保访问令牌具有适当的权限
数据备份: 重要操作前建议备份数据
开发和调试
本地测试
调试技巧
使用
response_format: "json"获取结构化响应检查 Torna 服务器日志获取详细错误信息
验证环境变量配置是否正确
贡献
欢迎提交 Issue 和 Pull Request 来改进这个 MCP 服务器。
许可证
本项目基于 MIT 许可证开源。
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Enables interaction with Torna API documentation management platform, allowing users to manage API documents, dictionaries, and modules through natural language commands.