Shortcut

🚀 Shortcut.com MCP 服务器

本项目实现的模型上下文协议（MCP）服务器，可用于访问和搜索 Shortcut.com 票务系统。它能让 Claude 等支持 MCP 协议的人工智能助手与 Shortcut.com 票务管理系统进行交互，为票务管理带来便利。

🚀 快速开始

本项目实现了与 Claude 和其他支持 MCP 协议的人工智能助手交互的 MCP 服务器，允许这些 AI 助手与 Shortcut.com 的票务管理系统进行交互。借助此集成，AI 助手可执行以下操作：

• 列出和搜索 Shortcut 中的故事（票务）
• 获取特定故事的详细信息
• 创建新故事
• 更新现有故事
• 向故事添加评论
• 检索工作流状态和项目

✨ 主要特性

• 丰富的票务操作：支持对 Shortcut.com 票务系统中的故事进行列出、搜索、创建、更新、添加评论等操作。
• 便捷的集成方式：可与 Claude 等支持 MCP 协议的人工智能助手集成，实现自动化票务管理。
• 多样化的功能接口：提供了多种 MCP 功能，包括资源访问、工具调用和提示生成等。

📦 安装指南

先决条件

• Python 3.10+
• Shortcut.com API 令牌

安装步骤

1. 克隆此仓库：

   git clone https://github.com/yourusername/mcp-server-shortcut.git
   cd mcp-server-shortcut
   

2. 创建虚拟环境并安装依赖项：

   # 使用uv（推荐）
   curl -LsSf https://astral.sh/uv/install.sh | sh  # 对于Mac/Linux
   uv venv
   source .venv/bin/activate  # 在Mac/Linux上或.venv\Scripts\activate在Windows上
   uv pip install -r requirements.txt
   
   # 使用pip
   python -m venv venv
   source venv/bin/activate  # 在Mac/Linux上或 venv\Scripts\activate 在 Windows 上
   pip install -r requirements.txt
   

3. 在项目根目录中创建一个 .env 文件，添加您的 Shortcut API 令牌：

   SHORTCUT_API_TOKEN=your_token_here
   SERVER_PORT=5000
   SERVER_HOST=0.0.0.0
   DEBUG_MODE=True
   

💻 使用示例

运行服务器

使用以下命令启动 MCP 服务器：

python -m src.server

配置 Claude Desktop

要将此 MCP 服务器与 Claude Desktop 一起使用：

1. 编辑 Claude Desktop 的配置文件：

   • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json

2. 添加 MCP 服务器配置：

   {
   "mcpServers": {
   "shortcut": {
   "command": "python",
   "args": ["-m", "src.server"],
   "env": {
   "SHORTCUT_API_TOKEN": "your_token_here"
   }
   }
   }
   }
   

3. 重启 Claude Desktop。

📚 详细文档

可用的 MCP 功能

资源

• shortcut://stories - 访问故事列表
• shortcut://story/{story_id} - 访问特定的故事

工具

• list_stories - 列出带可选过滤的故事
• search_stories - 使用文本查询搜索故事
• get_story_details - 获取特定故事的详细信息
• create_story - 创建新故事
• update_story - 更新现有故事
• add_comment - 向故事添加评论
• list_workflow_states - 列出所有工作流状态
• list_projects - 列出所有项目

提示

• create_bug_report - 生成错误报告模板
• create_feature_request - 生成功能请求模板

项目结构

• src/ - 源代码目录
  • server.py - MCP 服务器的主文件
  • client.py - 示例客户端代码，用于与 MCP 服务器交互
  • config.py - 配置设置和环境变量
  • requirements.txt - 项目所需的 Python 依赖项

开发

要向此项目添加新功能，请按照以下步骤操作：

1. 克隆仓库并在本地环境中安装依赖项。
2. 修改代码以添加所需的功能。
3. 测试更改，确保所有现有功能继续正常工作。
4. 提交更改并创建一个拉取请求。

贡献

我们欢迎社区的贡献！ 如果您发现任何问题或有任何改进建议，请提交问题或拉取请求。 请参考我们的贡献指南了解如何参与。

📄 许可证

此项目受MIT License许可保护。