项目简介

本项目实现了一个MCP服务器,旨在通过Model Context Protocol (MCP) 将 Linear Issue 管理工具集成到支持 MCP 协议的 LLM 客户端中。用户可以通过 LLM 客户端调用本服务器提供的工具,方便快捷地查询和创建 Linear Issues,提升开发和项目管理效率。

主要功能点

  • 获取团队 Issue 列表: 允许 LLM 客户端查询指定 Linear 团队的 Issue 列表,并可设置返回 Issue 数量上限。
  • 创建 Issue: 允许 LLM 客户端在指定 Linear 团队中创建新的 Issue,可设置 Issue 标题、描述和优先级。
  • 基于 Stdio 传输: 服务器通过标准输入输出 (stdio) 与 MCP 客户端进行通信,易于部署和集成。

安装步骤

  1. 克隆仓库: 首先克隆整个 GitHub 仓库到本地:

    git clone https://github.com/Just-Understanding-Data-Ltd/ai-coding-with-cursor.git
    cd ai-coding-with-cursor/linear_app_mcp_server
  2. 安装依赖: 确保已安装 Node.js 和 npm,然后在 'linear_app_mcp_server' 目录下运行以下命令安装项目依赖:

    npm install
  3. 配置环境变量: 复制 '.env.example' 文件并重命名为 '.env',然后根据您的 Linear 账号信息配置以下环境变量:

    LINEAR_API_KEY=YOUR_LINEAR_API_KEY  # 您的 Linear API Key 或 OAuth Token 二选一
    LINEAR_TEAM_ID=YOUR_LINEAR_TEAM_ID   # 您的 Linear 团队 ID

    请务必替换 'YOUR_LINEAR_API_KEY' 和 'YOUR_LINEAR_TEAM_ID' 为您的实际信息。您可以在 Linear 开发者设置中获取 API Key 和 Team ID。

  4. 构建服务器: 运行以下命令构建服务器代码:

    npm run build
  5. 运行服务器: 构建成功后,运行以下命令启动 MCP 服务器:

    npm run start

    服务器将通过 stdio 监听 MCP 客户端的请求。

服务器配置

MCP 客户端需要配置以下信息以连接到 Linear Issue Manager MCP 服务器。以下是一个 JSON 格式的配置示例,通常在 MCP 客户端的设置中进行配置:

{
  "serverName": "LinearIssueManager",
  "command": "node",
  "args": [
    "path/to/ai-coding-with-cursor/linear_app_mcp_server/dist/index.js"
  ],
  "transport": "stdio"
}

参数注释:

  • '"serverName"': 服务器名称,可以自定义,用于在客户端标识该服务器。例如: '"LinearIssueManager"'。
  • '"command"': 启动服务器的命令,这里使用 'node' 表示使用 Node.js 运行 JavaScript 代码。
  • '"args"': 启动命令的参数列表。
    • '"path/to/ai-coding-with-cursor/linear_app_mcp_server/dist/index.js"': 请替换为 'index.js' 文件在您本地文件系统中的绝对路径。此路径指向构建后的服务器入口文件。
  • '"transport"': 指定 MCP 服务器使用的传输协议,这里设置为 '"stdio"' 表示使用标准输入输出。

注意: 请务必将 '"path/to/ai-coding-with-cursor/linear_app_mcp_server/dist/index.js"' 替换为实际路径。您可以通过终端 'pwd' 命令获取当前目录,然后拼接相对路径得到绝对路径。

基本使用方法

  1. 启动 MCP 客户端: 确保您使用的 LLM 客户端支持 MCP 协议,并已正确安装和配置。

  2. 配置 MCP 服务器: 在 LLM 客户端中,根据上述“服务器配置”部分的信息,添加或配置 MCP 服务器连接。

  3. 调用工具: 在 LLM 客户端中,您可以使用自然语言指令或特定的命令来调用 Linear Issue Manager MCP 服务器提供的工具。

    例如,您可以指示 LLM 客户端执行以下操作:

    • "列出我的团队的 issues" (实际指令可能需要根据客户端的具体实现调整) - 这将调用 'get-team-issues' 工具获取 Issue 列表。
    • "创建一个标题为 '修复bug' 的 issue,描述为 '用户登录后页面报错'" (实际指令可能需要根据客户端的具体实现调整) - 这将调用 'create-issue' 工具创建新的 Issue。

    具体如何与 LLM 客户端交互以及如何触发工具调用,请参考您使用的 LLM 客户端的文档。

通过以上步骤,您就可以利用 Linear Issue Manager MCP 服务器,在 LLM 客户端中方便地管理您的 Linear Issues,提高工作效率。

信息

分类

开发者工具