Shortcut MCP服务器

一个用于与Shortcut API集成的MCP(模型上下文协议)服务器,提供用户电子邮件搜索和获取其分配的史诗和故事的功能。

  • by fredybustos
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 fredybustos/shortcut-mcp

使用说明

MCP服务器快捷方式

用于与快捷方式API集成的MCP(模型上下文协议)服务器。此服务器允许通过电子邮件搜索用户,并检索他们分配的史诗和故事。

特性

可用工具

  1. search_user_by_email -通过电子邮件地址搜索用户
  2. get_user_epics_by_email -获取用户的所有史诗(通过电子邮件搜索)
  3. get_user_stories_by_email -获取用户的所有故事(通过电子邮件搜索)
  4. get_user_work_by_email -在一次通话中为用户获取史诗和故事
  5. get_stories_by_due_date -获取按截止日期筛选的用户拥有的所有故事

需求

  • Node.js>=18
  • 快捷方式API令牌(设置→ 快捷方式工作区中的API令牌)

配置

克劳德代码(推荐)

claude mcp add shortcut-mcp -e SHORTCUT_API_TOKEN=your_token -- npx -y shortcut-mcp

克劳德桌面版

将此添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "shortcut": {
      "command": "npx",
      "args": ["-y", "shortcut-mcp"],
      "env": {
        "SHORTCUT_API_TOKEN": "your_token"
      }
    }
  }
}

VS代码副本

将此添加到您的VS代码配置中(~/Library/Application Support/Code/User/settings.json)或针对特定项目 .vscode/mcp.json:

{
  "shortcut": {
    "type": "stdio",
    "command": "npx",
    "args": ["-y", "shortcut-mcp"],
    "env": {
      "SHORTCUT_API_TOKEN": "your_token"
    },
    "gallery": true
  }
}

本地开发

git clone https://github.com/fredybustos/shortcut-mcp
cd shortcut-mcp
npm install
SHORTCUT_API_TOKEN=your_token npm run dev

刀具参数

搜索_用户_邮箱

  • email (string,必填):要搜索的用户的电子邮件

get_user_epics_by_email

  • email (string,必填):用户的电子邮件
  • limit (数字,可选):要返回的最大史诗数量(默认值:25)

get_user_stories_by_email

  • email (string,必填):用户的电子邮件
  • limit (数字,可选):要返回的最大故事数(默认值:25)

get_user_work_by_email

  • email (string,必填):用户的电子邮件
  • epic_limit (数量,可选):最大史诗数量(默认值:10)
  • story_limit (数字,可选):最大故事数(默认值:25)

get_stories_by_due_date

  • email (string,必填):用户的电子邮件地址
  • filterType (字符串,必填):筛选器类型: no_deadline, has_deadline, before_date, after_date, between_dates
  • startDate (字符串,可选):YYYY-MM-DD格式的开始日期(必填) before_date, after_date,以及 between_dates)
  • endDate (字符串,可选):YYYY-MM-DD格式的结束日期(必填) between_dates)
  • workflowStates (字符串数组,可选):按工作流状态名称筛选。可用: Backlog, Tasking, Todo, In progress, In review, In Qa, Ready to release, Released
  • limit (数字,可选):要返回的最大故事数(默认值:100)

回复

所有工具都以以下格式返回JSON:

{
  "success": true,
  "message": "Description of the result",
  "user": { },
  "epics": [ ],
  "stories": [ ]
}

局限性

  • 电子邮件搜索需要列出所有工作区成员(在快捷方式API中没有直接电子邮件搜索端点)。每个进程缓存结果5分钟。
  • 默认情况下设置分页限制以避免非常大的响应。
  • 需要在工作区中具有读取权限的有效API令牌。

贡献

我们欢迎捐款!如果您有改进、错误修复或新功能,请随时提交拉取请求。

致谢

感谢Fredy Bustos为Shortcut集成创建和维护此MCP服务器。