Canny MCP Server

与Canny.io集成的模型上下文协议（MCP）服务器，用于客户反馈管理。根据CIQ的CODE2原则构建，旨在提供以客户为中心、乐观、专注、高效和卓越的解决方案。

功能

以客户为中心

• 看板管理：列出并访问所有可用的Canny看板
• 帖子检索：获取详细的帖子信息，并支持灵活过滤
• 搜索能力：使用强大的搜索功能在多个看板中查找帖子
• 内容管理：无缝创建和更新帖子

高效且卓越

• 速率限制：内置保护机制防止API速率限制
• 错误处理：具有详细反馈的强大错误处理机制
• 验证：使用Zod模式进行输入验证
• 类型安全：完全实现TypeScript

安装

先决条件

• Node.js 18或更高版本
• Canny.io API密钥

快速开始

1. 安装依赖项：

   npm install
   

2. 设置环境变量：

   export CANNY_API_KEY="your_api_key_here"
   export CANNY_BASE_URL="https://canny.io/api/v1"  # 可选
   

3. 构建服务器：

   npm run build
   

4. 在开发模式下运行：

   npm run dev
   

环境变量

必需

• CANNY_API_KEY：您的Canny.io API密钥

可选

• CANNY_BASE_URL：API基础URL（默认：https://canny.io/api/v1）
• CANNY_TIMEOUT：请求超时时间（单位：毫秒，默认：30000）
• CANNY_MAX_RETRIES：最大重试次数（默认：3）
• CANNY_RATE_LIMIT_RPM：每分钟请求限制（默认：60）
• CANNY_RATE_LIMIT_BURST：突发限制（默认：10）

可用工具

看板工具

• get_boards：列出所有可访问的Canny看板

帖子工具

• get_posts：从特定看板中获取帖子，并带有筛选选项
• get_post：获取特定帖子的详细信息
• search_posts：跨看板搜索帖子
• create_post：在看板中创建新帖子
• update_post：更新现有帖子

使用示例

获取所有看板

{
  "name": "get_boards",
  "arguments": {}
}

从看板获取帖子

{
  "name": "get_posts",
  "arguments": {
    "boardId": "board_123",
    "limit": 10,
    "status": "open",
    "sort": "newest"
  }
}

搜索帖子

{
  "name": "search_posts",
  "arguments": {
    "query": "feature request",
    "limit": 20,
    "status": "open"
  }
}

创建帖子

{
  "name": "create_post",
  "arguments": {
    "authorId": "user_123",
    "boardId": "board_123",
    "title": "新功能请求",
    "details": "功能的详细描述"
  }
}

开发

运行测试

npm test

代码检查

npm run lint
npm run lint:fix

构建

npm run build

配置与Claude

添加到您的Claude MCP配置中：

{
  "mcpServers": {
    "canny": {
      "command": "node",
      "args": ["/path/to/canny-mcp-server/dist/server.js"],
      "env": {
        "CANNY_API_KEY": "your_api_key_here"
      }
    }
  }
}

错误处理

服务器实现了全面的错误处理：

• API速率限制保护
• 输入验证并带有详细错误消息
• 网络错误恢复并带有重试机制
• 对API失败的优雅处理

贡献

遵循CIQ的CODE2原则：

1. 以客户为中心：在每次贡献中都关注用户价值
2. 乐观：将挑战视为机会
3. 专注：全权拥有自己的贡献
4. 高效：利用现有的解决方案并在可能的情况下自动化
5. 卓越：保持高标准并持续改进

许可证

MIT许可证