使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在将 Linear 项目管理工具的功能集成到支持 MCP 协议的 LLM 应用中，例如 Cursor 编辑器。通过本项目提供的工具，LLM 可以与 Linear 进行交互，执行诸如创建 issue、搜索 issue、查询团队信息等任务，从而提升 LLM 在软件开发和项目管理领域的应用能力。

主要功能点

创建 Linear issue: 允许 LLM 通过指定标题、描述、团队 ID 等参数，在 Linear 中创建新的 issue。
搜索 Linear issue: 支持灵活的 issue 搜索功能，可以根据关键词、团队、状态、指派人、优先级等条件过滤 issue。
获取当前 Sprint 的 issue: 查询指定团队当前 Sprint (迭代) 中的所有 issue 列表。
搜索 Linear 团队: 根据团队名称关键词搜索 Linear 中的团队。
过滤当前 Sprint 的 issue (按状态过滤): 筛选指定团队当前 Sprint 中特定状态的 issue，并自动限定为当前用户指派的 issue。
获取团队的工作流状态 (workflow states): 获取指定团队可用的所有工作流状态（例如 "待办"、"进行中"、"已完成" 等）。
列出项目: 列出 Linear 中可用的项目，可以按团队筛选。

安装步骤

获取 Linear API Key: 访问 Linear 官方网站，登录后在 "Settings" (设置) > "API" 页面创建并获取您的 API 密钥。
克隆仓库或下载代码: 从 GitHub 仓库 https://github.com/MadeByNando/MCP-linear-Server 克隆代码到本地，或下载 ZIP 文件并解压。
配置环境变量:
- 在项目根目录下复制 '.env.example' 文件并重命名为 '.env'。
- 编辑 '.env' 文件，将您的 Linear API 密钥填入 'LINEAR_API_KEY' 变量，例如：
```
LINEAR_API_KEY=your_linear_api_key_here
```
安装依赖: 在项目根目录下打开终端，运行以下命令安装项目依赖：
```
npm install
```
构建项目 (可选): 如果需要生产环境部署，可以运行以下命令构建项目（将 TypeScript 代码编译为 JavaScript）：
```
npm run build
```
启动服务器: 根据需要选择以下方式启动服务器：
- 开发模式 (推荐): 用于本地开发和调试，支持代码热重载。
```
npm run dev
```
- 生产模式: 用于生产环境部署。
```
npm start
```
- Docker 部署: 如果您已安装 Docker 和 Docker Compose，可以使用 Docker 快速部署：
```
docker-compose up -d
```

服务器配置 (MCP 客户端配置)

要将此 MCP 服务器连接到 MCP 客户端（例如 Cursor），您需要在客户端中添加 MCP 服务器配置。以下是配置信息示例，以 JSON 格式提供：

直接运行 Node.js 服务器 (不使用 Docker)

{
  "serverName": "linear-mcp-server",  // MCP 服务器的名称，可以自定义
  "transport": "command",           // 传输类型，command 表示通过命令行启动和通信
  "command": "node dist/server.js",   // 启动 MCP 服务器的命令，指向编译后的 server.js 文件
  "args": []                         // 启动命令的参数，本例中无需额外参数
}

使用 Docker 运行服务器

{
  "serverName": "linear-mcp-server",  // MCP 服务器的名称，可以自定义
  "transport": "command",           // 传输类型，command 表示通过命令行启动和通信
  "command": "docker exec -i mcp-linear-server node dist/server.js", // 在 Docker 容器中执行启动命令
  "args": []                         // 启动命令的参数，本例中无需额外参数
}

配置说明:

'serverName': MCP 服务器的名称，您可以自定义设置，用于在 MCP 客户端中标识该服务器。
'transport': 传输类型，必须设置为 'command'，表明 MCP 客户端将通过命令行与 MCP 服务器进行通信。
'command': 重要，启动 MCP 服务器的命令。
- 不使用 Docker: 如果直接运行 Node.js 服务器，请确保已执行 'npm run build' 命令，并将 'command' 设置为指向编译后的 'dist/server.js' 文件。
- 使用 Docker: 如果使用 Docker 部署，请确保已通过 'docker-compose up -d' 启动容器，并将 'command' 设置为 'docker exec -i mcp-linear-server node dist/server.js'。其中 'mcp-linear-server' 是 Docker Compose 文件中定义的服务名称。
'args': 启动命令的参数，本例中服务器启动不需要额外的命令行参数，因此设置为空数组 '[]'。

基本使用方法

启动 MCP 服务器: 根据上述安装步骤启动 Linear MCP 服务器。
配置 MCP 客户端: 在支持 MCP 协议的 LLM 客户端（例如 Cursor 编辑器）中，打开 MCP 服务器配置页面，点击 "Add MCP Server" (添加 MCP 服务器)，根据上述 "服务器配置" 部分的说明，填写服务器名称、传输类型、启动命令等信息，并保存配置。
在 LLM 中使用工具: 配置完成后，您应该能在 LLM 客户端的工具列表中看到 "linear-mcp-server" 提供的工具。在与 LLM 的对话中，您可以指示 LLM 使用这些工具来操作 Linear。例如，您可以向 LLM 发出指令：
```
请使用 linear_create_issue 工具创建一个标题为 '修复用户登录页面 Bug'，团队ID为 'YOUR_TEAM_ID' 的 issue。
```
LLM 接收到指令后，会调用 'linear_create_issue' 工具，并根据您提供的参数与 Linear MCP 服务器交互，最终在 Linear 中创建 issue。

请根据您的实际部署环境和 MCP 客户端的要求，选择合适的服务器配置信息进行配置。

关键词