使用说明

项目简介

本项目 'mcp-linear-server' 是一个 MCP 服务器的实现，它将 Linear 项目管理工具的功能通过 Model Context Protocol (MCP) 协议暴露出来，使得支持 MCP 协议的 LLM 应用（如 Claude）能够与 Linear 进行交互，完成诸如创建 issue、搜索 issue、更新 issue 状态等任务。

主要功能点

创建 Issue: 允许 LLM 在指定的 Linear 团队中创建新的 issue。
搜索 Issue: 允许 LLM 根据关键词、团队、状态、负责人和优先级等条件搜索 Linear 中的 issue。
获取 Sprint Issue: 允许 LLM 获取指定团队当前 Sprint 中的所有 issue。
搜索团队: 允许 LLM 搜索和检索 Linear 中的团队信息。
过滤 Sprint Issue: 允许 LLM 筛选当前 Sprint 中指定状态且分配给当前用户的 issue。
批量更新 Issue 状态: 允许 LLM 批量更新多个 issue 的状态。
获取 Issue 详情: 允许 LLM 获取指定 issue 的详细信息，包括描述、评论等。

安装步骤

获取 Linear API Key: 访问 Linear 官方网站并登录您的账户，在 "Settings" -> "API" 页面创建并获取您的 API Key。
配置环境变量: 在项目根目录下创建 '.env' 文件，并添加以下内容，将 'your_api_key_here' 替换为您在步骤 1 中获取的 API Key。
```
LINEAR_API_KEY=your_api_key_here
```
安装依赖: 在项目根目录下打开终端，运行以下命令安装项目依赖。
```
npm install
```

服务器配置

MCP 客户端需要配置以下 JSON 信息才能连接到 'mcp-linear-server' 服务器。

{
  "serverName": "linear-mcp-server",  // MCP 服务器名称，可以自定义
  "command": "npm",                 // 启动服务器的命令，这里使用 npm
  "args": ["run", "dev"]           // 启动服务器命令的参数，'npm run dev' 启动开发模式服务器，'npm start' 启动生产模式服务器
}

配置参数说明:

'serverName': 服务器的名称，客户端可以用来标识不同的 MCP 服务器。您可以自定义此名称。
'command': 启动服务器的可执行命令。由于项目使用 npm 管理，并且在 'package.json' 中定义了启动脚本，所以这里使用 'npm' 命令。
'args': 启动命令的参数。'["run", "dev"]' 表示运行 'package.json' 中定义的 'dev' 脚本，用于启动开发模式的服务器（带自动重启）。如果需要启动生产模式，可以将 'args' 修改为 '["start"]'。

注意:

确保您的 MCP 客户端能够执行 'npm' 命令，并且项目根目录在客户端可访问的路径下。
首次运行前请务必完成 安装步骤 中的操作，特别是配置 'LINEAR_API_KEY' 环境变量。

基本使用方法

启动 'mcp-linear-server' 服务器。根据您的配置，运行 'npm run dev' 或 'npm start' 命令。
配置您的 MCP 客户端，使其连接到 'mcp-linear-server'。客户端需要使用上面 服务器配置 中提供的 JSON 信息进行配置。
通过 MCP 客户端（通常是 LLM 应用），您可以调用服务器提供的工具来与 Linear 进行交互。例如，您可以指示 LLM 使用 'linear_create_issue' 工具创建一个新的 issue，或使用 'linear_search_issues' 工具搜索现有的 issue。
服务器会将 Linear 的数据以文本形式返回给 MCP 客户端，LLM 应用可以解析这些文本信息并进行后续处理。

示例工具调用 (在 MCP 客户端中，以自然语言指示 LLM 使用工具):

"创建一个标题为 '修复用户登录问题'，团队 ID 为 'ENG' 的 Linear issue。" (对应 'linear_create_issue' 工具)
"搜索团队 ID 为 'DATA' 的所有 '待处理' 状态的 issue。" (对应 'linear_search_issues' 工具)
"列出团队 ID 为 'PROD' 的当前 Sprint 中的所有 issue。" (对应 'linear_sprint_issues' 工具)

请参考仓库的 'README.md' 文件和 'src/server.ts' 文件，了解每个工具的详细参数和使用方法。

关键词