使用说明

项目简介

Linear MCP Server 是一个 Model Context Protocol (MCP) 服务器,它充当 LLM 客户端和 Linear 项目管理工具之间的桥梁。通过此服务器,你可以让支持 MCP 协议的 LLM 应用(如 Claude、Cursor 等)安全、便捷地访问和操作 Linear 中的 Issues、Projects、Teams 和 Users 数据。这使得 AI 能够理解你的项目上下文,执行诸如创建 Issue、查询 Project 状态、更新 Issue 标签等操作,从而更智能地辅助开发工作流。

主要功能点

  • Issue 管理: 检索、创建、更新和删除 Linear Issues,管理 Issue 的属性(标签、负责人、优先级等)。
  • Comment 管理: 获取 Issue 的评论,创建新的评论。
  • Label 管理: 获取所有可用的标签,为 Issue 添加或移除标签。
  • Team 管理: 获取 Team 信息。
  • Project 管理: 获取 Project 和 Project Update 信息,创建 Project 和 Project Update。
  • User 管理: 获取 User 信息。
  • 工具化集成: 将 Linear 的各项功能封装为标准化的 MCP 工具,方便 LLM 客户端调用。
  • 灵活配置: 支持通过命令行参数灵活选择启用的工具组,满足不同场景的需求。
  • 易于部署: 提供 NPX 快速启动和 Docker 容器化部署方式。

安装步骤

方法一:使用 NPX 快速启动 (无需安装)

  1. 确保已安装 Node.js (版本 18+) 和 npm。

  2. 获取 Linear API Key,你需要在 Linear 账户设置中创建 API Key。

  3. 打开终端,运行以下 NPX 命令,启动 Linear MCP Server:

    npx @brs98/linear-mcp

    启动时,你需要设置 'LINEAR_API_KEY' 环境变量,例如:

    LINEAR_API_KEY=YOUR_LINEAR_API_KEY npx @brs98/linear-mcp

    或者,你也可以在运行命令前导出环境变量:

    export LINEAR_API_KEY=YOUR_LINEAR_API_KEY
    npx @brs98/linear-mcp

方法二:本地安装 (需要 Node.js 环境)

  1. 克隆仓库到本地:
    git clone https://github.com/brs98/linear-mcp.git
    cd linear-mcp
  2. 安装依赖:
    npm install
  3. 构建项目:
    npm run build
  4. 复制 '.env.example' 文件并重命名为 '.env',然后编辑 '.env' 文件,填入你的 Linear API Key:
    LINEAR_API_KEY=YOUR_LINEAR_API_KEY
  5. 启动服务器:
    npm start

方法三:Docker 部署 (需要 Docker 环境)

  1. 克隆仓库到本地:
    git clone https://github.com/brs98/linear-mcp.git
    cd linear-mcp
  2. 构建 Docker 镜像:
    docker build -t linear-mcp .
  3. 运行 Docker 容器,同样需要通过环境变量 '-e LINEAR_API_KEY=YOUR_LINEAR_API_KEY' 或者 '--env-file .env' 传入 Linear API Key:
    docker run -it -e LINEAR_API_KEY=YOUR_LINEAR_API_KEY linear-mcp
    或者使用 '.env' 文件:
    docker run -it --env-file .env linear-mcp

服务器配置

对于 MCP 客户端 (如 Claude, Cursor),你需要配置 MCP 服务器的启动命令和参数,以便客户端能够连接到 Linear MCP Server。以下是配置示例,请根据你的实际使用场景选择合适的配置:

配置示例 (JSON 格式):

示例 1: 使用 NPX 启动,包含 Issues, Projects, Teams 和 Users 工具

{
  "mcpServers": {
    "linear": {
      "command": "npx",
      "args": ["@brs98/linear-mcp"],
      "env": {
        "LINEAR_API_KEY": "<your-linear-api-key>"
      }
    }
  }
}

示例 2: 使用 NPX 启动,仅包含 Issues 和 Projects 工具

{
  "mcpServers": {
    "linear": {
      "command": "npx",
      "args": ["@brs98/linear-mcp", "--tools=issues,projects"],
      "env": {
        "LINEAR_API_KEY": "<your-linear-api-key>"
      }
    }
  }
}

示例 3: 本地安装后,使用 'npm start' 启动

{
  "mcpServers": {
    "linear-local": {
      "command": "npm",
      "args": ["start"],
      "cwd": "/path/to/your/linear-mcp",  // 请替换为你的 linear-mcp 项目本地路径
      "env": {
        "LINEAR_API_KEY": "<your-linear-api-key>"
      }
    }
  }
}

参数说明:

  • 'server name': 服务器名称,例如 "linear", "linear-local",用于在 MCP 客户端中标识和引用该服务器。
  • 'command': 启动服务器的命令,例如 "npx", "npm", "docker run"。
  • 'args': 传递给启动命令的参数,例如 '["@brs98/linear-mcp"]', '["@brs98/linear-mcp", "--tools=issues,projects"]', '["start"]'。
    • '"--tools=工具列表"': 指定启用的工具组,多个工具组用逗号分隔,例如 "issues,projects,teams"。 可选工具组包括:'issues', 'comments', 'labels', 'projects', 'teams', 'users'。
    • 更多命令行选项请参考仓库 README 文档。
  • 'env': 传递给服务器进程的环境变量,例如 '{"LINEAR_API_KEY": "<your-linear-api-key>"}'。
    • 'LINEAR_API_KEY': 必须配置,你的 Linear API Key,用于服务器访问 Linear API。
    • 其他环境变量 (如 'SERVER_NAME', 'SERVER_VERSION', 'LOG_LEVEL') 可在 '.env' 文件中配置,或者通过此 'env' 字段传递。
  • 'cwd': (可选) 工作目录,如果使用 'npm start' 等相对路径命令启动本地安装的服务器,需要指定项目根目录。

基本使用方法

  1. 启动 Linear MCP Server (根据上述安装和配置步骤)。
  2. 在支持 MCP 协议的 LLM 客户端中,配置并连接到 Linear MCP Server。
  3. 在 LLM 客户端中,可以使用自然语言指令,通过 MCP 协议调用 Linear MCP Server 提供的工具,例如:
    • "列出我所有的 Linear Issues" (客户端会调用 'getIssues' 工具)
    • "创建一个标题为 '修复bug' 的 Issue,分配给 '张三',优先级设为 '高'" (客户端会调用 'createIssue' 工具)
    • "获取 Project '项目A' 的状态" (客户端会调用 'getProject' 工具)

具体的工具调用和参数格式,请参考仓库中 'src/tools' 目录下的工具定义文件,以及 MCP 协议的官方文档。

注意: 由于 Linear MCP Server 通过标准输入/输出 (stdio) 与 MCP 客户端通信,因此你需要确保 LLM 客户端支持 stdio 连接方式。

信息

分类

生产力应用