zan-tapd-mcp 0.0.1__tar.gz

zan_tapd_mcp-0.0.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: zan-tapd-mcp
+Version: 0.0.1
+Summary: TAPD MCP Server
+Author-email: ryanjhzheng <zhengjianhong95@gmail.com>
+Keywords: mcp,tapd
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: httpx
+Requires-Dist: requests
+Requires-Dist: markdown
+Requires-Dist: mcp[cli]<2,>=1.0.0
+
+# TAPD MCP Server
+
+TAPD 是腾讯敏捷研发管理平台，覆盖需求、计划、研发、测试、发布研发全生命周期。支持用自然语言与 TAPD 对话，实现需求、缺陷、任务、迭代等管理。
+
+* 与 TAPD API 无缝集成，提升开发效率
+
+## 系统要求
+
+* uv
+* TAPD Access Token（推荐）或 TAPD API 账号密码
+
+## 快速开始
+### Install uv
+```
+brew install uv
+# OR
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### 参数
+- TAPD_ACCESS_TOKEN: 个人令牌（推荐）
+- TAPD_API_USER: API账号 
+- TAPD_API_PASSWORD: API密钥 
+- BOT_URL: 企业微信机器人 webhook 地址，如果需要发送消息到企业微信群才需要填（选填）
+
+注意 TAPD_API_USER/TAPD_API_PASSWORD（TAPD API 账号密码） 与 TAPD_ACCESS_TOKEN（TAPD 个人授权令牌）为两种调用 MCP 的凭据，选一种即可。
+
+
+### 获取 TAPD Access Token（推荐）
+TAPD_ACCESS_TOKEN 为 TAPD 个人令牌，在 [我的设置-个人访问令牌](https://www.tapd.cn/personal_settings/index?tab=personal_token)  点“创建个人访问令牌”，令牌只显示一次，注意保存下来。
+
+### 获取 API 账号密码（兼容）
+
+1. 未注册，请前往 [注册](https://www.tapd.cn?from_partner=copilot&source=tapd_operation_copilot)
+2. 已注册但未授权API，请前往API配置：登录TAPD，点击进入 [公司管理-API账号管理](https://www.tapd.cn/open_platform/open_api_redirect?from_partner=copilot&source=tapd_operation_copilot)，复制API账号和API密钥
+
+
+## IDE 配置
+### CodeBuddy / Claude Desktop / Cursor
+#### 本地 stdio 运行，环境变量配置示例（推荐个人 Token）
+```json
+{
+  "mcpServers": {
+    "mcp-server-tapd": {
+      "command": "uvx",
+      "args": ["--from", "zan-tapd-mcp", "mcp-server-tapd"],
+      "env": {
+        "TAPD_ACCESS_TOKEN": "您的个人Token",
+        // 兼容账号密码方式（如未配置 Token 时生效）
+        "TAPD_API_USER": "",
+        "TAPD_API_PASSWORD": "",
+        "TAPD_API_BASE_URL": "https://api.tapd.cn",
+        "TAPD_BASE_URL": "https://www.tapd.cn",
+        "BOT_URL": ""
+      }
+    }
+  }
+}
+```
+
+
+### Streamable HTTP 配置
+使用 Streamable HTTP 替代 stdio
+1. 在终端启动已发布的服务
+```
+uvx --from zan-tapd-mcp mcp-server-tapd --mode=streamable-http --host="0.0.0.0" --port=8000 --api-user=your_api_user --api-password=your_api_password --api-base-url=https://api.tapd.cn --tapd-base-url=https://www.tapd.cn --bot-url="https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX"
+
+# 如果使用个人 Token，则将 --api-user=your_api_user --api-password=your_api_password 替换为 --access-token=您的个人Token
+
+```
+
+2. 通过如下配置连接到已启动的服务
+```json
+{
+  "mcpServers": {
+    "tapd_mcp_http": {
+      "url": "http://localhost:8000/mcp/"
+    }
+  }
+}
+```
+
+## 富媒体描述
+`create_bug`、`update_bug`、`create_story_or_task`、`update_story_or_task`、`create_comments`、`update_comments` 支持把外部图片或视频直链直接写进 TAPD 富文本描述/评论。
+
+可用参数：
+- `media`: 结构化媒体列表，例如 `[{ "type": "image", "url": "https://example.com/a.png" }, { "type": "video", "url": "https://example.com/demo.mp4" }]`
+- `image_url` / `image_urls`: 单个或多个图片直链
+- `video_url` / `video_urls`: 单个或多个视频直链
+
+示例：
+```json
+{
+  "workspace_id": 55508687,
+  "title": "支付回调失败",
+  "options": {
+    "description": "复现步骤见下方录屏",
+    "media": [
+      { "type": "image", "url": "https://example.com/screenshot.png", "alt": "错误截图" },
+      { "type": "video", "url": "https://example.com/demo.mp4" }
+    ]
+  }
+}
+```
+
+注意：
+- 图片/视频必须是浏览器可直接访问的直链
+- 使用临时签名 URL 时，链接过期后 TAPD 中的媒体也会失效

zan_tapd_mcp-0.0.1/README.md

@@ -0,0 +1,108 @@
+# TAPD MCP Server
+
+TAPD 是腾讯敏捷研发管理平台，覆盖需求、计划、研发、测试、发布研发全生命周期。支持用自然语言与 TAPD 对话，实现需求、缺陷、任务、迭代等管理。
+
+* 与 TAPD API 无缝集成，提升开发效率
+
+## 系统要求
+
+* uv
+* TAPD Access Token（推荐）或 TAPD API 账号密码
+
+## 快速开始
+### Install uv
+```
+brew install uv
+# OR
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+### 参数
+- TAPD_ACCESS_TOKEN: 个人令牌（推荐）
+- TAPD_API_USER: API账号 
+- TAPD_API_PASSWORD: API密钥 
+- BOT_URL: 企业微信机器人 webhook 地址，如果需要发送消息到企业微信群才需要填（选填）
+
+注意 TAPD_API_USER/TAPD_API_PASSWORD（TAPD API 账号密码） 与 TAPD_ACCESS_TOKEN（TAPD 个人授权令牌）为两种调用 MCP 的凭据，选一种即可。
+
+
+### 获取 TAPD Access Token（推荐）
+TAPD_ACCESS_TOKEN 为 TAPD 个人令牌，在 [我的设置-个人访问令牌](https://www.tapd.cn/personal_settings/index?tab=personal_token)  点“创建个人访问令牌”，令牌只显示一次，注意保存下来。
+
+### 获取 API 账号密码（兼容）
+
+1. 未注册，请前往 [注册](https://www.tapd.cn?from_partner=copilot&source=tapd_operation_copilot)
+2. 已注册但未授权API，请前往API配置：登录TAPD，点击进入 [公司管理-API账号管理](https://www.tapd.cn/open_platform/open_api_redirect?from_partner=copilot&source=tapd_operation_copilot)，复制API账号和API密钥
+
+
+## IDE 配置
+### CodeBuddy / Claude Desktop / Cursor
+#### 本地 stdio 运行，环境变量配置示例（推荐个人 Token）
+```json
+{
+  "mcpServers": {
+    "mcp-server-tapd": {
+      "command": "uvx",
+      "args": ["--from", "zan-tapd-mcp", "mcp-server-tapd"],
+      "env": {
+        "TAPD_ACCESS_TOKEN": "您的个人Token",
+        // 兼容账号密码方式（如未配置 Token 时生效）
+        "TAPD_API_USER": "",
+        "TAPD_API_PASSWORD": "",
+        "TAPD_API_BASE_URL": "https://api.tapd.cn",
+        "TAPD_BASE_URL": "https://www.tapd.cn",
+        "BOT_URL": ""
+      }
+    }
+  }
+}
+```
+
+
+### Streamable HTTP 配置
+使用 Streamable HTTP 替代 stdio
+1. 在终端启动已发布的服务
+```
+uvx --from zan-tapd-mcp mcp-server-tapd --mode=streamable-http --host="0.0.0.0" --port=8000 --api-user=your_api_user --api-password=your_api_password --api-base-url=https://api.tapd.cn --tapd-base-url=https://www.tapd.cn --bot-url="https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=XXX"
+
+# 如果使用个人 Token，则将 --api-user=your_api_user --api-password=your_api_password 替换为 --access-token=您的个人Token
+
+```
+
+2. 通过如下配置连接到已启动的服务
+```json
+{
+  "mcpServers": {
+    "tapd_mcp_http": {
+      "url": "http://localhost:8000/mcp/"
+    }
+  }
+}
+```
+
+## 富媒体描述
+`create_bug`、`update_bug`、`create_story_or_task`、`update_story_or_task`、`create_comments`、`update_comments` 支持把外部图片或视频直链直接写进 TAPD 富文本描述/评论。
+
+可用参数：
+- `media`: 结构化媒体列表，例如 `[{ "type": "image", "url": "https://example.com/a.png" }, { "type": "video", "url": "https://example.com/demo.mp4" }]`
+- `image_url` / `image_urls`: 单个或多个图片直链
+- `video_url` / `video_urls`: 单个或多个视频直链
+
+示例：
+```json
+{
+  "workspace_id": 55508687,
+  "title": "支付回调失败",
+  "options": {
+    "description": "复现步骤见下方录屏",
+    "media": [
+      { "type": "image", "url": "https://example.com/screenshot.png", "alt": "错误截图" },
+      { "type": "video", "url": "https://example.com/demo.mp4" }
+    ]
+  }
+}
+```
+
+注意：
+- 图片/视频必须是浏览器可直接访问的直链
+- 使用临时签名 URL 时，链接过期后 TAPD 中的媒体也会失效

zan_tapd_mcp-0.0.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "zan-tapd-mcp"
+version = "0.0.1"
+description = "TAPD MCP Server"
+authors = [{ name = "ryanjhzheng", email = "zhengjianhong95@gmail.com" }]
+readme = "README.md"
+requires-python = ">=3.13"
+keywords = ["mcp", "tapd"]
+dependencies = [
+  "httpx",
+  'requests',
+  'markdown',
+  "mcp[cli]>=1.0.0,<2",
+]
+
+[project.scripts]
+mcp-server-tapd = "mcp_server_tapd.server:main"

zan_tapd_mcp-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

zan_tapd_mcp-0.0.1/src/mcp_server_tapd/__init__.py

@@ -0,0 +1,14 @@
+import asyncio
+
+from . import server
+from . import tapd
+
+__version__ = "2.1.4"
+
+
+def main():
+    """Main entry point for the package."""
+    asyncio.run(server.main())
+
+
+__all__ = ["main", "server", "tapd", "__version__"]

zan_tapd_mcp-0.0.1/src/mcp_server_tapd/app_config.py

@@ -0,0 +1,131 @@
+import os
+import argparse
+from dotenv import load_dotenv
+import configparser
+from typing import Dict, Any, Optional
+
+
+class AppConfig:
+    def __init__(self):
+        # 定义参数默认值和必填性
+        self.params_meta = {
+            "api_user": {"required": False, "type": str, "default": None},
+            "api_password": {"required": False, "type": str, "default": None},
+            "api_base_url": {"required": False, "type": str, "default": None},
+            "tapd_base_url": {"required": False, "type": str, "default": None},
+            "bot_url": {"required": False, "type": str, "default": None},
+            "mode": {"required": False, "type": str, "default": "stdio"},
+            "host": {"required": False, "type": str, "default": "0.0.0.0"},
+            "port": {"required": False, "type": int, "default": 8000},
+            "path": {"required": False, "type": str, "default": "/mcp"},
+            "access_token": {"required": False, "type": str, "default": None},
+        }
+        # 加载配置
+        self.config = self._load_all_configs()
+
+    def _load_cli_args(self) -> Dict[str, Any]:
+        """从命令行参数获取配置"""
+        parser = argparse.ArgumentParser()
+        parser.add_argument("--access-token", help="TAPD Access Token")
+        parser.add_argument("--api-user", help="API User")
+        parser.add_argument("--api-password", help="API Password")
+        parser.add_argument("--api-base-url", help="API BASE URL")
+        parser.add_argument("--tapd-base-url", help="TAPD BASE URL")
+        parser.add_argument("--bot-url", help="QiWei Bot URL")
+        parser.add_argument(
+            "--mode",
+            help="server mode(stdio/sse/http(alias for sse)/streamable-http)",
+        )
+        parser.add_argument("--host", help="Host")
+        parser.add_argument("--port", help="Port")
+        parser.add_argument("--path", help="Path")
+        args, _ = parser.parse_known_args()
+
+        return {
+            "access_token": args.access_token,
+            "api_user": args.api_user,
+            "api_password": args.api_password,
+            "api_base_url": args.api_base_url,
+            "tapd_base_url": args.tapd_base_url,
+            "bot_url": args.bot_url,
+            "mode": args.mode,
+            "host": args.host,
+            "port": args.port,
+            "path": args.path,
+        }
+
+    def _load_env_vars(self) -> Dict[str, Any]:
+        """从环境变量获取配置"""
+        return {
+            "access_token": os.getenv("TAPD_ACCESS_TOKEN"),
+            "api_user": os.getenv("TAPD_API_USER"),
+            "api_password": os.getenv("TAPD_API_PASSWORD"),
+            "api_base_url": os.getenv("TAPD_API_BASE_URL"),
+            "tapd_base_url": os.getenv("TAPD_BASE_URL"),
+            "bot_url": os.getenv("BOT_URL"),
+            # "mode": os.getenv("MODE"),
+        }
+
+    def _load_dotenv(self) -> Dict[str, Any]:
+        """从 .env 文件获取配置"""
+        load_dotenv()
+        return self._load_env_vars()  # 复用环境变量加载逻辑
+
+    def _merge_configs(self, *config_sources) -> Dict[str, Any]:
+        """按优先级合并配置源"""
+        merged = {}
+        for source in config_sources:
+            for param, value in source.items():
+                if value is not None and merged.get(param) is None:
+                    merged[param] = value
+        return merged
+
+    def _type_cast(self, raw_config: Dict[str, Any]) -> Dict[str, Any]:
+        """类型转换和验证"""
+        processed = {}
+        for param, meta in self.params_meta.items():
+            raw_value = raw_config.get(param)
+
+            # 应用默认值（当未配置且允许默认值时）
+            if raw_value is None and not meta["required"]:
+                processed[param] = meta["default"]
+                continue
+
+            # 必填参数校验
+            if meta["required"] and raw_value is None:
+                raise ValueError(f"参数 {param} 为必填项！")
+
+            # 类型转换
+            try:
+                if meta["type"] == bool:
+                    # 处理布尔类型（支持 true/1/yes）
+                    processed[param] = str(raw_value).lower() in ("true", "1", "yes")
+                else:
+                    processed[param] = meta["type"](raw_value)
+            except (ValueError, TypeError):
+                raise TypeError(f"参数 {param} 类型错误，期望 {meta['type'].__name__}")
+
+        return processed
+
+    def _load_all_configs(self) -> Dict[str, Any]:
+        """加载并合并所有配置源"""
+        # 按优先级加载配置（从高到低）
+        cli_config = self._load_cli_args()
+        env_config = self._load_env_vars()
+        dotenv_config = self._load_dotenv()
+
+        # 合并配置
+        merged_raw = self._merge_configs(cli_config, env_config, dotenv_config)
+
+        # 类型转换和验证
+        return self._type_cast(merged_raw)
+
+    def get(self, param_name: str) -> Optional[Any]:
+        """获取配置项"""
+        return self.config.get(param_name)
+
+    def __getattr__(self, name: str) -> Any:
+        """支持属性式访问（config.api_password）"""
+        if name in self.config:
+            return self.config[name]
+        raise AttributeError(f"未找到配置项: {name}")