vidhex_mcp 0.3.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 vid
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,131 @@
1
+ Metadata-Version: 2.4
2
+ Name: vidhex_mcp
3
+ Version: 0.3.1
4
+ Summary: Video Skill MCP server + agent skill + CLI (install / login / jobs)
5
+ License-Expression: MIT
6
+ Requires-Python: >=3.10
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE
9
+ Requires-Dist: mcp>=2.2.0
10
+ Requires-Dist: httpx>=0.28.0
11
+ Requires-Dist: keyring>=24.0
12
+ Provides-Extra: dev
13
+ Requires-Dist: pytest>=8.3.0; extra == "dev"
14
+ Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
15
+ Requires-Dist: ruff>=0.8.0; extra == "dev"
16
+ Dynamic: license-file
17
+
18
+ # vidhex_mcp
19
+
20
+ Video Skill 的 MCP 服务器 —— 通过 API 网关提供视频超分(2x/3x/4x)与任务进度查询,
21
+ 并附带 agent skill 和 `vidhex_mcp` CLI(install / login / status / points)。
22
+ 以 stdio 方式接入 Claude Code 等 MCP 客户端。
23
+
24
+ ## 一句话安装(可复制给智能体)
25
+
26
+ > 运行 `pip install vidhex_mcp && vidhex_mcp install --api-url <网关地址> --api-key vsk_live_xxx`,把 vidhex_mcp 注册为 stdio MCP 服务器并部署 video-skill skill;重启 Claude Code 后运行 `vidhex_mcp login` 完成授权,用 `vidhex_mcp --version` 确认已是最新版本。
27
+
28
+ 网关和密钥已经配置过时,可以简化为:
29
+
30
+ > 运行 `pip install vidhex_mcp && vidhex_mcp install`,完成后重启客户端并运行 `vidhex_mcp login` 授权。
31
+
32
+ ### 为什么推荐 pip / uv tool,而不是 uvx
33
+
34
+ 0.2.0 起安装不只是注册 MCP 服务器,还会部署 agent skill;skill 需要通过 Bash 调用
35
+ `vidhex_mcp status` / `vidhex_mcp login`。`pip install` 与 `uv tool install` 会把
36
+ `vidhex_mcp` 放进 PATH,而 `uvx vidhex_mcp install` 只在 uvx 的临时环境里执行,
37
+ CLI 不会出现在 PATH,skill 的登录流程会退化。
38
+
39
+ ```bash
40
+ # 推荐:隔离安装,CLI 常驻 PATH
41
+ uv tool install vidhex_mcp
42
+ vidhex_mcp install --api-url https://your-gateway --api-key vsk_live_xxx
43
+ ```
44
+
45
+ 只想接入 MCP 工具、不需要 skill 和本机 login 时,才用:
46
+
47
+ ```bash
48
+ uvx vidhex_mcp install --api-url https://your-gateway --api-key vsk_live_xxx
49
+ ```
50
+
51
+ `install` 会完成五件事:
52
+
53
+ 1. 识别当前是 uvx / pip 脚本 / `python -m` 启动,生成可执行且不依赖 PATH 的启动命令;
54
+ 2. 合并写入用户级 `~/.claude.json`(`--scope project` 时写项目 `.mcp.json`),
55
+ 其他 MCP 服务器原样保留;
56
+ 3. 把包内的 `video-skill` skill 部署到 `~/.claude/skills/video-skill/`
57
+ (`--scope project` 时为 `<项目>/.claude/skills/video-skill/`,`--no-skill` 可跳过);
58
+ 4. 把 `--api-key` / `--api-url` 存进 `~/.video_skill/config.json`(权限 600),
59
+ MCP 配置里只写网关地址,不重复保存密钥;
60
+ 5. 用生成的条目跑一次 `--check` 做启动验证。
61
+
62
+ ## 命令
63
+
64
+ | 命令 | 说明 |
65
+ |------|------|
66
+ | `vidhex_mcp install` | 注册 MCP + 部署 skill(默认用户级) |
67
+ | `vidhex_mcp install --scope project` | 写入当前项目的 `.mcp.json` 与 skills |
68
+ | `vidhex_mcp install --no-skill` | 只注册 MCP,不部署 skill |
69
+ | `vidhex_mcp login` | 浏览器授权登录(交互式,由用户执行) |
70
+ | `vidhex_mcp logout` | 清除本机登录凭证 |
71
+ | `vidhex_mcp status` | 查看登录状态与配置摘要 |
72
+ | `vidhex_mcp points` | 查询实时积分余额(`account` 同义) |
73
+ | `vidhex_mcp uninstall` | 从配置中移除,并删除已部署的 skill |
74
+ | `vidhex_mcp check` | 自检配置并打印摘要 |
75
+ | `vidhex_mcp` | 无参数时启动 stdio 服务器(由客户端调用) |
76
+
77
+ `install` 常用参数:
78
+
79
+ - `--api-key vsk_live_...`:写入本地凭证文件
80
+ - `--api-url https://...`:网关地址
81
+ - `--command "vidhex_mcp"`:覆盖自动探测的启动命令
82
+ - `--dry-run`:只打印将写入的配置
83
+ - `--no-verify`:跳过启动验证
84
+ - `--no-skill`:不部署 agent skill
85
+ - `--force`:配置文件损坏时先备份(`.bak`)再重建
86
+
87
+ ## 配置来源
88
+
89
+ 按优先级从高到低读取:
90
+
91
+ 1. 环境变量 `VIDEO_SKILL_API_KEY` / `VIDEO_SKILL_API_URL` / `VIDEO_SKILL_AUTH_URL`
92
+ 2. `~/.video_skill/config.json`(`install` 写入的位置)
93
+ 3. 内置默认值(授权服务地址有默认值,网关地址必须显式配置)
94
+
95
+ ## 本地登录
96
+
97
+ 登录是 **CLI 命令**,不是 MCP 工具。在终端运行:
98
+
99
+ ```bash
100
+ vidhex_mcp login
101
+ ```
102
+
103
+ 它会打开浏览器完成授权,凭证保存在系统钥匙串(Windows 凭据管理器 / macOS Keychain /
104
+ Linux Secret Service)。MCP 服务器与 CLI 共用同一份凭证;登录后当前 MCP 进程最多
105
+ 15 秒内即可读到新凭证,若客户端仍提示未登录,重新加载窗口或重启客户端即可。
106
+
107
+ API Key 仍然必需:它用于网关鉴权;登录提供的是计费身份(`user_token`),两者不能互相替代。
108
+
109
+ ## Agent Skill
110
+
111
+ `SKILL.md` 与 `references/` 随本包分发,`install` 会自动部署。skill 只描述当前开放的
112
+ 两个工具(`video_super_resolution` / `check_job_status`),并明确要求登录、退出、余额
113
+ 通过 CLI 完成。没有部署 skill 时,MCP 工具仍可直接调用。
114
+
115
+ ## 升级
116
+
117
+ ```bash
118
+ pip install --upgrade vidhex_mcp # 或 uv tool upgrade vidhex_mcp
119
+ vidhex_mcp install # 刷新 MCP 配置,并重新部署 skill
120
+ vidhex_mcp --version # 确认版本
121
+ ```
122
+
123
+ 然后重启 Claude Code(或重新加载窗口),让 MCP 服务器进程换上新版本。
124
+ 只升级包、不重新运行 `install` 的话,`~/.claude/skills/video-skill/` 里仍是旧 skill。
125
+
126
+ > Windows 上如果 MCP 服务器正在运行,升级可能因 `vidhex_mcp.exe` 被占用而报
127
+ > “拒绝访问 (os error 5)”——先退出客户端再升级;使用 uvx 方式安装则不受影响。
128
+
129
+ ## 许可证
130
+
131
+ MIT
@@ -0,0 +1,114 @@
1
+ # vidhex_mcp
2
+
3
+ Video Skill 的 MCP 服务器 —— 通过 API 网关提供视频超分(2x/3x/4x)与任务进度查询,
4
+ 并附带 agent skill 和 `vidhex_mcp` CLI(install / login / status / points)。
5
+ 以 stdio 方式接入 Claude Code 等 MCP 客户端。
6
+
7
+ ## 一句话安装(可复制给智能体)
8
+
9
+ > 运行 `pip install vidhex_mcp && vidhex_mcp install --api-url <网关地址> --api-key vsk_live_xxx`,把 vidhex_mcp 注册为 stdio MCP 服务器并部署 video-skill skill;重启 Claude Code 后运行 `vidhex_mcp login` 完成授权,用 `vidhex_mcp --version` 确认已是最新版本。
10
+
11
+ 网关和密钥已经配置过时,可以简化为:
12
+
13
+ > 运行 `pip install vidhex_mcp && vidhex_mcp install`,完成后重启客户端并运行 `vidhex_mcp login` 授权。
14
+
15
+ ### 为什么推荐 pip / uv tool,而不是 uvx
16
+
17
+ 0.2.0 起安装不只是注册 MCP 服务器,还会部署 agent skill;skill 需要通过 Bash 调用
18
+ `vidhex_mcp status` / `vidhex_mcp login`。`pip install` 与 `uv tool install` 会把
19
+ `vidhex_mcp` 放进 PATH,而 `uvx vidhex_mcp install` 只在 uvx 的临时环境里执行,
20
+ CLI 不会出现在 PATH,skill 的登录流程会退化。
21
+
22
+ ```bash
23
+ # 推荐:隔离安装,CLI 常驻 PATH
24
+ uv tool install vidhex_mcp
25
+ vidhex_mcp install --api-url https://your-gateway --api-key vsk_live_xxx
26
+ ```
27
+
28
+ 只想接入 MCP 工具、不需要 skill 和本机 login 时,才用:
29
+
30
+ ```bash
31
+ uvx vidhex_mcp install --api-url https://your-gateway --api-key vsk_live_xxx
32
+ ```
33
+
34
+ `install` 会完成五件事:
35
+
36
+ 1. 识别当前是 uvx / pip 脚本 / `python -m` 启动,生成可执行且不依赖 PATH 的启动命令;
37
+ 2. 合并写入用户级 `~/.claude.json`(`--scope project` 时写项目 `.mcp.json`),
38
+ 其他 MCP 服务器原样保留;
39
+ 3. 把包内的 `video-skill` skill 部署到 `~/.claude/skills/video-skill/`
40
+ (`--scope project` 时为 `<项目>/.claude/skills/video-skill/`,`--no-skill` 可跳过);
41
+ 4. 把 `--api-key` / `--api-url` 存进 `~/.video_skill/config.json`(权限 600),
42
+ MCP 配置里只写网关地址,不重复保存密钥;
43
+ 5. 用生成的条目跑一次 `--check` 做启动验证。
44
+
45
+ ## 命令
46
+
47
+ | 命令 | 说明 |
48
+ |------|------|
49
+ | `vidhex_mcp install` | 注册 MCP + 部署 skill(默认用户级) |
50
+ | `vidhex_mcp install --scope project` | 写入当前项目的 `.mcp.json` 与 skills |
51
+ | `vidhex_mcp install --no-skill` | 只注册 MCP,不部署 skill |
52
+ | `vidhex_mcp login` | 浏览器授权登录(交互式,由用户执行) |
53
+ | `vidhex_mcp logout` | 清除本机登录凭证 |
54
+ | `vidhex_mcp status` | 查看登录状态与配置摘要 |
55
+ | `vidhex_mcp points` | 查询实时积分余额(`account` 同义) |
56
+ | `vidhex_mcp uninstall` | 从配置中移除,并删除已部署的 skill |
57
+ | `vidhex_mcp check` | 自检配置并打印摘要 |
58
+ | `vidhex_mcp` | 无参数时启动 stdio 服务器(由客户端调用) |
59
+
60
+ `install` 常用参数:
61
+
62
+ - `--api-key vsk_live_...`:写入本地凭证文件
63
+ - `--api-url https://...`:网关地址
64
+ - `--command "vidhex_mcp"`:覆盖自动探测的启动命令
65
+ - `--dry-run`:只打印将写入的配置
66
+ - `--no-verify`:跳过启动验证
67
+ - `--no-skill`:不部署 agent skill
68
+ - `--force`:配置文件损坏时先备份(`.bak`)再重建
69
+
70
+ ## 配置来源
71
+
72
+ 按优先级从高到低读取:
73
+
74
+ 1. 环境变量 `VIDEO_SKILL_API_KEY` / `VIDEO_SKILL_API_URL` / `VIDEO_SKILL_AUTH_URL`
75
+ 2. `~/.video_skill/config.json`(`install` 写入的位置)
76
+ 3. 内置默认值(授权服务地址有默认值,网关地址必须显式配置)
77
+
78
+ ## 本地登录
79
+
80
+ 登录是 **CLI 命令**,不是 MCP 工具。在终端运行:
81
+
82
+ ```bash
83
+ vidhex_mcp login
84
+ ```
85
+
86
+ 它会打开浏览器完成授权,凭证保存在系统钥匙串(Windows 凭据管理器 / macOS Keychain /
87
+ Linux Secret Service)。MCP 服务器与 CLI 共用同一份凭证;登录后当前 MCP 进程最多
88
+ 15 秒内即可读到新凭证,若客户端仍提示未登录,重新加载窗口或重启客户端即可。
89
+
90
+ API Key 仍然必需:它用于网关鉴权;登录提供的是计费身份(`user_token`),两者不能互相替代。
91
+
92
+ ## Agent Skill
93
+
94
+ `SKILL.md` 与 `references/` 随本包分发,`install` 会自动部署。skill 只描述当前开放的
95
+ 两个工具(`video_super_resolution` / `check_job_status`),并明确要求登录、退出、余额
96
+ 通过 CLI 完成。没有部署 skill 时,MCP 工具仍可直接调用。
97
+
98
+ ## 升级
99
+
100
+ ```bash
101
+ pip install --upgrade vidhex_mcp # 或 uv tool upgrade vidhex_mcp
102
+ vidhex_mcp install # 刷新 MCP 配置,并重新部署 skill
103
+ vidhex_mcp --version # 确认版本
104
+ ```
105
+
106
+ 然后重启 Claude Code(或重新加载窗口),让 MCP 服务器进程换上新版本。
107
+ 只升级包、不重新运行 `install` 的话,`~/.claude/skills/video-skill/` 里仍是旧 skill。
108
+
109
+ > Windows 上如果 MCP 服务器正在运行,升级可能因 `vidhex_mcp.exe` 被占用而报
110
+ > “拒绝访问 (os error 5)”——先退出客户端再升级;使用 uvx 方式安装则不受影响。
111
+
112
+ ## 许可证
113
+
114
+ MIT
@@ -0,0 +1,37 @@
1
+ [project]
2
+ name = "vidhex_mcp"
3
+ version = "0.3.1"
4
+ description = "Video Skill MCP server + agent skill + CLI (install / login / jobs)"
5
+ readme = "README.md"
6
+ license = "MIT"
7
+ license-files = ["LICENSE"]
8
+ requires-python = ">=3.10"
9
+ dependencies = [
10
+ "mcp>=2.2.0",
11
+ "httpx>=0.28.0",
12
+ # 本地登录凭证落 OS 凭据库(Windows 凭据管理器 / macOS Keychain /
13
+ # Linux Secret Service);拿不到时不静默降级,见 auth.py。
14
+ "keyring>=24.0",
15
+ ]
16
+
17
+ [project.optional-dependencies]
18
+ dev = [
19
+ "pytest>=8.3.0",
20
+ "pytest-asyncio>=0.24.0",
21
+ "ruff>=0.8.0",
22
+ ]
23
+
24
+ [project.scripts]
25
+ vidhex_mcp = "video_skill_mcp.server:main"
26
+ # 旧命令保留为别名,已写入的 .mcp.json 不会因改名失效
27
+ video-skill-mcp = "video_skill_mcp.server:main"
28
+
29
+ [tool.setuptools.package-data]
30
+ "video_skill_mcp" = [
31
+ "skills/video-skill/SKILL.md",
32
+ "skills/video-skill/references/*.md",
33
+ ]
34
+
35
+ [build-system]
36
+ requires = ["setuptools>=77.0"]
37
+ build-backend = "setuptools.build_meta"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
File without changes
@@ -0,0 +1,6 @@
1
+ """``python -m video_skill_mcp`` —— 与 ``vidhex_mcp`` console script 等价。"""
2
+
3
+ from video_skill_mcp.server import main
4
+
5
+ if __name__ == "__main__":
6
+ main()