使用说明

项目简介

本项目 'mcp-servers' 仓库旨在提供一系列基于 Model Context Protocol (MCP) 的服务器实现,以便将不同的应用服务(如 Shortcut)集成到支持 MCP 协议的 LLM 客户端(如 Claude、Cursor、Windsurf 等)中。其中,'shortcut-mcp-server' 模块专注于 Shortcut 项目管理工具的 MCP 服务器实现。

主要功能点

  • Shortcut 集成: 将 Shortcut 项目管理工具的功能集成到 LLM 应用中。
  • 资源访问: 允许 LLM 客户端通过 MCP 服务器访问和操作 Shortcut 中的项目、故事、任务等资源。
  • 工具注册: 将 Shortcut API 的功能注册为 MCP 工具,供 LLM 客户端调用,例如查询项目信息、创建任务等。
  • 标准化接口: 遵循 MCP 协议标准,提供统一的接口与 LLM 客户端通信。

安装步骤

  1. 安装 Bun: 确保您的开发环境中已安装 Bun 包管理器。您可以访问 https://bun.sh/ 了解安装方法。
  2. 克隆仓库: 将 'mcp-servers' 仓库克隆到本地:
    git clone https://github.com/madisonbullard/mcp-servers
  3. 进入仓库目录: 导航到克隆的仓库目录:
    cd mcp-servers
  4. 安装依赖: 使用 Bun 安装项目依赖:
    bun install
  5. 构建服务器: 构建 Shortcut MCP 服务器模块:
    bun run build

服务器配置

MCP 服务器是为 MCP 客户端(例如 Claude、Cursor、Windsurf)提供服务的后端应用。您需要在 MCP 客户端中配置服务器连接信息。以下是针对 'shortcut-mcp-server' 的配置示例(JSON 格式):

{
  "serverName": "shortcut",
  "command": "bun",
  "args": [ "run", "packages/shortcut-mcp-server/dist/server.js" ],
  "env": {
    "SHORTCUT_API_TOKEN": "<Your Shortcut API Token>"  // 请替换为您的 Shortcut API Token
  }
}

配置参数说明:

  • '"serverName"': 服务器名称,设置为 '"shortcut"'。
  • '"command"': 启动服务器的命令,这里使用 'bun' 运行 JavaScript 文件。
  • '"args"': 命令参数,指定要运行的服务器 JavaScript 文件路径 'packages/shortcut-mcp-server/dist/server.js'。
  • '"env"': 环境变量配置,用于传递 Shortcut API Token。
    • '"SHORTCUT_API_TOKEN"': 请务必替换 '<Your Shortcut API Token>' 为您在 Shortcut 平台申请的 API Token。 这是服务器连接 Shortcut API 的凭证。

重要提示:

  • 在 MCP 客户端中配置服务器时,请复制以上 JSON 配置,并根据您的实际情况修改 '"SHORTCUT_API_TOKEN"' 的值。
  • MCP 客户端需要读取并使用此配置信息来启动和连接到 'shortcut-mcp-server'。

基本使用方法

  1. 设置 API Token 环境变量: 在您的操作系统或终端环境中,设置 'SHORTCUT_API_TOKEN' 环境变量,并将其值设置为您的 Shortcut API Token。
  2. 启动 MCP 服务器: 无需手动启动服务器。当 MCP 客户端(如 Claude)需要连接到 Shortcut MCP 服务器时,会根据您在客户端中配置的服务器信息自动启动服务器。
  3. 在 LLM 客户端中使用: 在支持 MCP 协议的 LLM 客户端中,配置并启用已添加的 Shortcut MCP 服务器。您可以通过自然语言指令,指示 LLM 客户端调用 Shortcut 提供的工具,例如查询 Story 信息、创建 Task 等,以实现与 Shortcut 项目管理工具的交互。

信息

分类

开发者工具