关于 Marzban MCP
Marzban MCP 是用于管理 Marzban 面板的 TypeScript MCP 服务,面向 AI Agent 和 MCP 客户端。它基于 MarzbanSDK,与相关工具共享认证和 API 行为。
主要功能
- 01管理 Marzban 面板操作
- 02基于 Marzban TypeScript SDK
- 03共享认证与重试行为
适用场景
- 01通过 AI Agent 管理 Marzban 面板
- 02通过 MCP 客户端调用 Marzban 操作
MCP 相关
它将 Marzban 操作作为工具提供给 AI Agent 和其他 MCP 客户端。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
npx -y marzban-mcpMARZBAN_BASE_URLURL of the Marzban panel.MARZBAN_USERNAMEMarzban administrator username.MARZBAN_PASSWORD密钥Marzban administrator password.本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。
工具
15收录的工具列表 · 更新于 1 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| section | string | 否 | 返回此顶层键的原始 JSON,而非摘要(例如 "inbounds"、"routing")。使用 "raw" 获取完整配置。省略此参数可获取结构化摘要——除非确实需要完整 JSON,否则优先使用摘要而非 "raw"。 |
详细介绍
一个用于 Marzban 的 TypeScript SDK,以及构建在其之上的一切。在 SDK 中修复一个 bug 或添加一个端点,MCP 服务、命令行工具以及所有基于它构建的应用都能自动获得这些改进。
各部分如何协同
flowchart LR
Panel(["Marzban Panel"])
SDK["marzban-sdk"]
MCP["marzban-mcp<br/>MCP server"]
CLI["marzban-cli<br/>CLI · WIP"]
App["Your app<br/>Node · Bun · Deno · Browser"]
Agents(["Claude · Cursor · any MCP client"])
Panel <--> SDK
SDK --> MCP --> Agents
SDK --> CLI
SDK --> App
SDK 与你的 Marzban 面板通信。MCP 服务和命令行工具只是同一个 SDK 的客户端 ——相同的认证、相同的重试、相同的类型化错误——因此它们永远不会彼此偏离, 也不会与你的代码产生偏差。
包
| 包 | npm | Docker | 说明 |
|---|---|---|---|
packages/sdk | marzban-sdk | — | TypeScript SDK —— 认证、重试、弹性 WebSocket 重连、Webhook、生命周期 |
packages/mcp | marzban-mcp | ilmar7786/marzban-mcp | 一个 MCP 服务,将 Marzban 操作作为工具暴露给 AI Agent |
packages/cli | — | — | 基于 SDK 的命令行工具 —— 开发中,尚未发布 |
apps/docs | — | — | 文档站点 |
每个可发布的包都有自己的版本、README.md、变更日志和发布标签
(sdk-v*、mcp-v*、cli-v*)。
文档
完整的指南、配置参考和完整的类型化 API 位于 ilmar7786.github.io/marzban-sdk。
关于仓库本身是如何构建的——架构、约定、测试、
CI 和发布——请参阅 docs/。
贡献
欢迎贡献——请参阅 CONTRIBUTING.md 了解如何 提交补丁。发现了 bug 或有想法? 提交 issue。
许可证
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。