关键词

Shortcut项目管理任务管理API集成工作流自动化

使用说明

项目简介

Shortcut MCP Server 是一个基于 Node.js 开发的 MCP 服务器，它桥接了 Model Context Protocol (MCP) 与 Shortcut (原 Clubhouse) 项目管理平台。该服务器允许支持 MCP 协议的客户端应用，通过标准化的方式访问和操作 Shortcut 中的项目数据和功能，从而实现更智能化的项目管理工作流。

主要功能点

  • MCP 协议支持: 实现了 MCP 服务器的核心协议，能够接收和处理 MCP 客户端发送的符合协议规范的请求。
  • Shortcut 集成: 深度整合 Shortcut API，可以将 Shortcut 项目管理平台的数据和功能以资源和工具的形式暴露给 MCP 客户端。
  • 上下文数据访问: 允许 LLM 应用通过 MCP 协议安全地访问 Shortcut 中的项目、任务、成员等信息，作为上下文数据。
  • 功能扩展: 可能支持将 Shortcut 的操作（如创建任务、更新状态等）注册为 MCP 工具，供 LLM 客户端调用，实现自动化工作流。

安装步骤

  1. 安装 Node.js: 确保您的环境中已安装 Node.js (v18 或更高版本) 和 npm。
  2. 克隆仓库: 使用 Git 克隆 'shortcut-mcp-server' 仓库到本地： 
    git clone https://github.com/davidteren/shortcut-mcp-server.git
cd shortcut-mcp-server
  3. 安装依赖: 在项目根目录下运行 npm 命令安装项目依赖： 
    npm install
  4. 配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，然后根据您的 Shortcut API Token 和希望使用的端口修改 '.env' 文件中的配置： 
    SHORTCUT_API_TOKEN=your_api_token_here  # 替换为您的 Shortcut API Token
MCP_SERVER_PORT=3000                   # MCP 服务器监听的端口，可自定义

服务器配置

MCP 客户端需要配置以下信息以连接到 Shortcut MCP Server：

{
  "serverName": "Shortcut MCP Server",
  "command": "npm",
  "args": ["run", "dev"]
}
  • 'serverName': 服务器名称，可自定义，用于在客户端标识连接。
  • 'command': 启动服务器的命令，这里使用 'npm'。
  • 'args': 启动命令的参数，'["run", "dev"]' 表示执行 'npm run dev' 命令来启动开发服务器。

注意: 上述配置是开发环境下的配置，适用于快速启动和测试。在生产环境中，建议先使用 'npm run build' 构建项目，然后使用 'npm start' 或其他适合生产环境的命令启动服务器，并相应地修改 'args' 配置。

基本使用方法

  1. 启动服务器: 在项目根目录下运行 'npm run dev' 命令启动 Shortcut MCP Server 开发服务器。
  2. 配置 MCP 客户端: 在您的 MCP 客户端应用中，根据上述 “服务器配置” 部分的信息配置连接到 Shortcut MCP Server。
  3. 通过 MCP 客户端与 Shortcut 交互: 使用 MCP 客户端发送符合 MCP 协议的请求，即可与 Shortcut MCP Server 交互，获取 Shortcut 项目数据或调用相关功能。具体的交互方式和支持的功能取决于 Shortcut MCP Server 的具体实现和 MCP 客户端的功能。

信息

分类

生产力应用

访问项目