使用说明

项目简介

MCP RepomiX Linear App 是一个基于 Model Context Protocol (MCP) 构建的工具服务器,旨在为 AI 应用提供与 Linear issue 追踪系统集成的能力。通过注册和管理一系列工具,该服务器允许 LLM (大型语言模型) 客户端调用 Linear 的功能,例如创建、搜索、更新 issue 以及管理评论等,从而扩展 LLM 在软件开发和项目管理领域的应用场景。

主要功能点

  • 工具注册系统: 提供简单而强大的工具注册机制,方便开发者快速集成新的 Linear 功能。
  • 类型安全的工具定义: 使用 TypeScript 和 Zod 确保工具接口的类型安全和参数验证。
  • 增强的错误处理: 自动处理工具执行过程中的错误,包括参数验证错误和运行时异常,并返回结构化的错误信息。
  • 会话感知: 支持会话管理,允许工具在会话上下文中运行,并处理请求取消信号。
  • Linear Issue 追踪集成: 预置了丰富的工具集,涵盖 Linear issue 追踪系统的常用操作,例如:
    • 搜索 issue (支持关键词、状态、优先级过滤)
    • 获取 issue 详情
    • 创建 issue
    • 更新 issue
    • 获取 issue 评论
    • 创建 issue 评论
    • 更新 issue 评论
    • 获取用户 Profile
    • 获取团队 ID

安装步骤

  1. 克隆仓库

    git clone https://github.com/zalab-inc/mcp-linear-app.git
    cd mcp-linear-app
  2. 安装依赖

    npm install
  3. 构建项目

    npm run build

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到 MCP RepomiX Linear App 服务器。请注意,你需要预先设置 Linear API 密钥 (LINEAR_API_KEY) 作为环境变量。

{
  "serverName": "mcp-repomix",  // MCP 服务器名称,与 src/index.ts 中 McpServer 实例化的 name 属性一致
  "command": "npm",             // 启动服务器的命令,这里使用 npm
  "args": ["start"]             // 启动命令的参数,npm start 会执行 package.json 中 scripts.start 定义的脚本
}

基本使用方法

  1. 启动服务器

    在项目根目录下执行以下命令启动 MCP 服务器:

    npm start

    服务器将通过标准输入/输出 (stdio) 与 MCP 客户端通信。

  2. 配置 MCP 客户端

    在 MCP 客户端中,配置上述 '服务器配置' 中提供的 JSON 信息,并确保客户端与服务器通过 stdio 连接。

  3. 调用工具

    客户端连接成功后,即可调用服务器提供的工具。例如,可以使用 'search_issues' 工具搜索 Linear issues,或使用 'create_issue' 工具创建新的 issue。 工具的具体参数和使用方法请参考工具的描述信息。

    例如,调用 'search_issues' 工具搜索标题包含 "bug" 的 issue:

    {
      "tool_call": {
        "tool_name": "search_issues",
        "tool_arguments": {
          "keyword": "bug"
        }
      }
    }

    服务器将返回包含搜索结果的 JSON-RPC 响应。

信息

分类

开发者工具