Kirha Crypto Smithery Gateway

🚀 Kirha Smithery Gateway

Kirha Smithery Gateway 是一个可配置的 MCP（模型上下文协议）服务器，专为 Kirha 工具规划设计，可随时与 Smithery 配合使用。

✨ 主要特性

• JSON 配置：可轻松配置工具、业务领域和 API 端点。
• 动态工具注册：工具会根据配置进行注册。
• 基于会话的 API 密钥：每个会话都有自己的 API 密钥，确保工具执行的安全性。
• 调试模式：开发时可选择开启调试日志。
• 模块化架构：工具存于单独文件中，实现了清晰的关注点分离。

📦 安装指南

环境配置（smithery.yaml）

runtime: "container"
startCommand:
  type: "http"
  configSchema:
    type: "object"
    properties:
      apiKey:
        type: "string"
        description: "Your API key"
      debug:
        type: "boolean"
        description: "Enable debug logging"
        default: false
      configPath:
        type: "string"
        description: "Path to custom configuration file"
    required: ["apiKey"]

JSON 配置（config.json）

{
  "mcp": {
    "name": "kirha-crypto",
    "version": "1.0.0"
  },
  "tool": {
    "name": "execute-crypto-tool-planning",
    "title": "Crypto Tool Planning",
    "description": "Execute crypto-related tool planning",
    "enabled": true
  },
  "vertical": "crypto",
  "api": {
    "executeToolPlanningUrl": "https://api.kirha.ai/chat/v1/tool-planning/execute",
    "summarization": {
      "enable": true,
      "model": "kirha-flash"
    }
  }
}

📚 详细文档

创建不同业务领域的分支

若要为不同的业务领域创建分支，请按以下步骤操作：

1. 将 config.example.json 复制为 config.json。
2. 更新配置：
   • 将 mcp.name 更改为你的业务领域名称。
   • 将 vertical 更新为你的业务领域 ID。
   • 使用你特定的工具修改 tool 对象。
   • 更新 tool.name、tool.title 和 tool.description。

项目结构

src/
├── index.ts              # 主服务器入口点
├── types.ts              # 类型定义
└── tools/
    └── toolPlanning.ts   # 工具规划实现

开发步骤

# 安装依赖
npm install

# 在开发模式下运行
npm run dev

# 为生产环境构建
npm run build

# 启动构建后的服务器
npm start

添加新工具

1. 在 src/tools/ 目录下创建一个新文件（例如 newTool.ts）。
2. 按照 ToolRegistrationFunction 类型实现工具注册函数。
3. 将该工具添加到 src/index.ts 中的 availableTools 映射中。
4. 更新你的 config.json 以包含新工具。

会话管理

• 每个客户端连接都会从 Smithery 获取自己的 API 密钥。
• 配置在连接时绑定。
• 工具可以访问特定于会话的配置。
• API 密钥会安全地传递给工具执行函数。

调试模式

在会话配置中设置 debug: true 以启用调试模式：

GET /mcp?apiKey=your-key&debug=true

这将记录以下信息：

• 配置加载
• 工具注册
• 工具执行
• 错误详情