README
🚀 mcp-server-linear
mcp-server-linear是一个与Linear API交互的模型上下文协议(MCP)服务器。它通过标准化的MCP接口,提供了访问和操作Linear问题、项目及其他数据的工具和资源,为客户端应用程序与Linear之间搭建了便捷的桥梁。
🚀 快速开始
mcp-server-linear项目作为客户端应用程序(特别是AI助手和其他工具)与Linear之间的桥梁,提供了对Linear资源的标准化接口访问。以下是快速启动该项目的步骤:
- 安装依赖:通过pnpm安装项目所需依赖。
pnpm install
- 启动服务器:启动MCP服务器。
pnpm run start
✨ 主要特性
- 标准访问:提供对Linear资源(问题、项目、举措、团队)的标准访问。
- CRUD操作:支持问题和评论的完整CRUD操作。
- 筛选搜索:具备问题的高级筛选和搜索功能。
- 错误处理:拥有一致的错误处理和响应格式。
- 集成能力:可与AI助手通过MCP协议集成。
📦 安装指南
安装依赖
通过pnpm安装项目依赖:
pnpm install
启动服务器
启动MCP服务器:
pnpm run start
配置选项
环境变量
LINEAR_API_KEY:必需的环境变量,用于身份验证。PORT:可选,默认为3000。指定服务器运行的端口。
身份验证
此服务器支持两种身份验证方式:
1. API密钥认证
在环境中设置LINEAR_API_KEY变量。例如:
LINEAR_API_KEY=your_api_key_here pnpm run start
2. OAuth认证
配置 OAuth 客户端并使用获取的访问令牌进行身份验证。
💻 使用示例
操作命令
# 启动服务器(包含调试模式)
pnpm run start -- --debug
# 定义日志文件路径
pnpm run start -- --log-file custom.log
MCP监察工具
使用MCP监察工具与服务器交互:
- 全局安装MCP监察工具:
pnpm install -g @modelcontextprotocol/inspector
- 使用npx启动监察工具:
LINEAR_API_KEY=your_api_key_here npx -y @modelcontextprotocol/inspector @mkusaka/mcp-server-linear
🔧 技术细节
此服务器遵循模型上下文协议(MCP)架构,提供标准化方式访问Linear资源。关键架构决策包括:
- 资源组织:按领域将资源组织在单独的文件中。
- 错误处理:所有资源的一致错误处理。
- 响应格式:一致的JSON响应格式。
有关详细信息,请参阅adr.md。
📚 详细文档
开发命令
# 运行测试
pnpm test
# 构建项目
pnpm run build
# 监视更改
pnpm run watch
# 以调试模式运行
pnpm run debug
📄 许可证
本项目采用MIT许可证。
🤝 贡献
欢迎贡献!请参考adr.md了解架构决策和项目结构。
Scan to join WeChat group