MCP Remnawave

mcp-remnawave

英语 | 俄语

______________________________________________________________________

Remnawave面板的MCP服务器

版本： 1.2.0 | Remnawave API： 2.7.4

特性

• 153工具 -全面管理用户、节点、主机、订阅、小队、HWID、配置文件、边界、API令牌、计费、片段、外部小队、设置、订阅页面配置、节点插件、IP控制和元数据
• 3资源 --实时面板统计数据、节点状态、健康检查
• 5个提示 --常见任务的指导工作流程
• 只读模式 --限制为69个只读工具用于安全监控
• 球童支持 — X-Api-Key Caddy后面带有自定义路径的面板标题
• 类型安全 --建立在 @remnawave/后端合约 用于API路由验证
• stdio传输 --适用于Claude Desktop、Cursor、Windsurf和任何兼容MCP的客户端

需求

• Node.js>=22
• 带有API令牌的Remnawave面板（设置>API令牌）

安装

git clone https://github.com/TrackLine/mcp-remnawave.git
cd mcp-remnawave
npm install
npm run build

配置

创建一个 .env 文件或传递环境变量：

REMNAWAVE_BASE_URL=https://vpn.example.com
REMNAWAVE_API_TOKEN=your-api-token-here

带有自定义路径的球童

如果您的Remnawave面板部署在后面 带有自定义路径和API密钥保护的Caddy，将基本URL设置为包括自定义路径并提供API密钥：

REMNAWAVE_BASE_URL=https://example.com/your-secret-path/api
REMNAWAVE_API_KEY=your-caddy-api-key

这 X-Api-Key 标头将自动添加到每个请求中。

只读模式

集 REMNAWAVE_READONLY=true 禁用所有写入操作（创建、更新、删除、启用、禁用、重新启动、撤销、重置）。只会注册读取/列表工具。

可用于监控仪表板或共享环境，以防止意外更改。

在只读模式下，可用工具从153个减少到69个：

使用Claude Desktop

添加到您的Claude Desktop配置(~/Library/Application Support/Claude/claude_desktop_config.json 在macOS上）：

{
  "mcpServers": {
    "remnawave": {
      "command": "node",
      "args": ["/absolute/path/to/remnawave-mcp/dist/index.js"],
      "env": {
        "REMNAWAVE_BASE_URL": "https://vpn.example.com",
        "REMNAWAVE_API_TOKEN": "your-api-token-here",
        "REMNAWAVE_API_KEY": "your-caddy-api-key",
        "REMNAWAVE_READONLY": "false"
      }
    }
  }
}

使用光标/风帆

添加 .cursor/mcp.json 或 .windsurf/mcp.json 在您的项目中：

{
  "mcpServers": {
    "remnawave": {
      "command": "node",
      "args": ["/absolute/path/to/remnawave-mcp/dist/index.js"],
      "env": {
        "REMNAWAVE_BASE_URL": "https://vpn.example.com",
        "REMNAWAVE_API_TOKEN": "your-api-token-here",
        "REMNAWAVE_API_KEY": "your-caddy-api-key",
        "REMNAWAVE_READONLY": "false"
      }
    }
  }
}

码头工人

npm run build
docker compose up -d

环境变量通过以下方式传递 .env 文件或 docker-compose.yml.

可用工具

用户（27工具）

节点（15个工具）

主机（11个工具）

系统（10个工具）

订阅（10个工具）

配置文件和限制（9个工具）

内部小队（7个工具）

HWID设备（7个工具）

API代币（3个工具）

注册机（1个工具）

基础设施计费（12个工具）

片段（4个工具）

外部小队（8个工具）

设置（2个工具）

订阅页面配置（7个工具）

节点插件（11个工具）

IP控制（5个工具）

元数据（4个工具）

资源

提示

示例查询

"Show me all users with expired subscriptions"
"Create user vasya with 50 GB limit for one month"
"Restart node amsterdam-01"
"Give me a traffic report for the last week"
"Disable users who exceeded their traffic limit"
"Which nodes are offline right now?"
"Show billing history"
"List all node plugins"
"Get IP connections for user X"

项目结构

src/
├── index.ts                       # Entry point (stdio transport)
├── server.ts                      # McpServer setup
├── config.ts                      # Environment config
├── client/
│   └── index.ts                   # Remnawave HTTP client
├── tools/
│   ├── helpers.ts                 # Result formatting helpers
│   ├── index.ts                   # Tool registration
│   ├── users.ts                   # User management (27 tools)
│   ├── nodes.ts                   # Node management (15 tools)
│   ├── hosts.ts                   # Host management (11 tools)
│   ├── system.ts                  # System & auth (10 tools)
│   ├── subscriptions.ts           # Subscriptions (10 tools)
│   ├── inbounds.ts                # Config profiles & inbounds (9 tools)
│   ├── squads.ts                  # Internal squads (7 tools)
│   ├── hwid.ts                    # HWID devices (7 tools)
│   ├── infra-billing.ts           # Infrastructure billing (12 tools)
│   ├── node-plugins.ts            # Node plugins (11 tools)
│   ├── external-squads.ts         # External squads (8 tools)
│   ├── subscription-page-configs.ts # Subscription page configs (7 tools)
│   ├── ip-control.ts              # IP control (5 tools)
│   ├── snippets.ts                # Snippets (4 tools)
│   ├── metadata.ts                # Node & user metadata (4 tools)
│   ├── api-tokens.ts              # API tokens (3 tools)
│   ├── settings.ts                # Panel settings (2 tools)
│   └── keygen.ts                  # Keygen (1 tool)
├── resources/
│   └── index.ts                   # MCP resources
└── prompts/
    └── index.ts                   # MCP prompts

许可证

麻省理工学院

______________________________________________________________________

RemnaWave Panel的MCP服务器

版本： 1.2.0 | Remnawave API： 2.7.4

机会

• 153工具 -完全控制用户、节点、主机、订阅、组、HWID、配置文件、Inbounds、API令牌、计费、Snippet、外部组、设置、订阅页面、节点插件、IP控制和元数据
• 3资源 -面板统计，节点状态，实时健康检查
• 5个插件 -典型任务的逐步脚本
• Readonly模式 -最多69种只读工具
• 支持Caddy -标题 X-Api-Key 用于自定义路径的Caddy面板
• 类型安全 - 建立在 @remnawave/后端合约 用于验证API路由
• stdio 运输 适用于Claude Desktop、Cursor、Windsurf和任何MCP兼容的客户端

要求

• Node.js>=22
• 带API令牌的RemnaWave面板（设置>API令牌）

安装

git clone https://github.com/TrackLine/mcp-remnawave.git
cd mcp-remnawave
npm install
npm run build

配置

创建文件 .env 或者传递环境变量：

变种必备说明 |------------|-------------|----------| | REMNAWAVE_BASE_URL | 是 | URL面板（例如 https://vpn.example.com) | | REMNAWAVE_API_TOKEN –是的–面板设置中的API令牌› | REMNAWAVE_API_KEY ÐÐÐÐÐÐÐÐÐÐÐÐÐÐÐ | REMNAWAVE_READONLY 没有 true 启用只读模式。

REMNAWAVE_BASE_URL=https://vpn.example.com
REMNAWAVE_API_TOKEN=ваш-api-токен

卡迪定制路径

如果您的RemnaWave面板部署在 带定制路径和API密钥保护的Caddy，在base URL中指定完整路径并提供API密钥：

REMNAWAVE_BASE_URL=https://example.com/your-secret-path/api
REMNAWAVE_API_KEY=ваш-caddy-api-ключ

标题 X-Api-Key 将自动添加到每个请求中。

Readonly模式

安装 REMNAWAVE_READONLY=true禁用所有写入操作（创建、更新、删除、启用、禁用、重新启动、吊销、重置）。只注册阅读工具。

对于监视仪表板或需要排除意外更改的公共环境非常有用。

在Readonly模式下，可用工具的数量从153个减少到69个：

分类可用工具 |-----------|----------------------| 用户（10） users_list, users_get, users_get_by_username, users_get_by_short_uuid, users_get_by_telegram_id, users_get_by_email, users_get_by_tag, users_get_by_subscription_uuid, users_tags_list, users_resolve | 诺德（3） nodes_list, nodes_get, nodes_tags_list | 主机（3） hosts_list, hosts_get, hosts_tags_list | 系统（10）→所有工具（仅限自然阅读）→ →订阅（10）→所有工具（仅限自然阅读）→ –配置文件和Inbounds（5）→ config_profiles_list, config_profiles_get, inbounds_list, config_profiles_get_inbounds, config_profiles_get_computed_config | 内部团队（2） squads_list, squads_accessible_nodes | |HWID（4）| hwid_devices_list, hwid_devices_list_all, hwid_stats, hwid_top_users | API token（1） api_tokens_list | |Keygen（1）| keygen_get | 比林（4） billing_providers_list, billing_provider_get, billing_nodes_list, billing_history_list | Snippets（1） snippets_list | 外部团体（2） external_squads_list, external_squads_get | 设置（1） settings_get | 订阅页面（2） sub_page_configs_list, sub_page_configs_get | NOD插件（4） node_plugins_list, node_plugins_get, node_plugins_torrent_reports, node_plugins_torrent_stats | IP控制（4） ip_control_fetch_ips, ip_control_get_fetch_ips_result, ip_control_fetch_users_ips, ip_control_get_fetch_users_ips_result | 元数据（2） metadata_node_get, metadata_user_get |

使用Claude Desktop

添加Claude Desktop（~/Library/Application Support/Claude/claude_desktop_config.json macOS）：

{
  "mcpServers": {
    "remnawave": {
      "command": "node",
      "args": ["/абсолютный/путь/к/remnawave-mcp/dist/index.js"],
      "env": {
        "REMNAWAVE_BASE_URL": "https://vpn.example.com",
        "REMNAWAVE_API_TOKEN": "ваш-api-токен",
        "REMNAWAVE_API_KEY": "ваш-caddy-api-ключ",
        "REMNAWAVE_READONLY": "false"
      }
    }
  }
}

使用Cursor/Windsurf

添加到 .cursor/mcp.json 或 .windsurf/mcp.json 您的项目：

{
  "mcpServers": {
    "remnawave": {
      "command": "node",
      "args": ["/абсолютный/путь/к/remnawave-mcp/dist/index.js"],
      "env": {
        "REMNAWAVE_BASE_URL": "https://vpn.example.com",
        "REMNAWAVE_API_TOKEN": "ваш-api-токен",
        "REMNAWAVE_API_KEY": "ваш-caddy-api-ключ",
        "REMNAWAVE_READONLY": "false"
      }
    }
  }
}

码头工人

npm run build
docker compose up -d

环境变量通过 .env 或文件 docker-compose.yml.

可用工具

用户（27个工具）

工具描述模式 |------------|----------|-------| | users_list 用户列表（Read） | users_get 用户使用UUID Read | users_get_by_username 用户用户名Read | users_get_by_short_uuid 使用Short UUID浏览 | users_get_by_telegram_id 使用Telegram ID阅读 | users_get_by_email 用户通过电子邮件阅读 | users_get_by_tag 用户点击Read | users_get_by_subscription_uuid –通过UUID订阅获取用户–Read→ | users_tags_list 用户标签列表Read | users_resolve 根据多个标准搜索用户Read | users_create 创建新用户Write | users_update 更新用户设置 | users_delete 删除用户Write | users_enable 用户登录Write | users_disable 关闭用户Write | users_revoke_subscription ◎取消订阅（重新生成链接）→Write› | users_reset_traffic 重置流量计数器 | users_bulk_delete_by_status 大规模删除状态（Write） | users_bulk_update 大规模更新Write | users_bulk_reset_traffic 大流量重置Write | users_bulk_revoke_subscription #22269；大批量订阅，Write？ | users_bulk_delete 大规模删除Write | users_bulk_update_squads #22269；组的大规模更新。 | users_bulk_extend_expiration #22312；期延长，写作。 | users_bulk_all_update 更新所有用户Write | users_bulk_all_reset_traffic 重置所有用户的流量 | users_bulk_all_extend_expiration 延长所有用户的使用寿命

Noda（15个工具）

工具描述模式 |------------|----------|-------| | nodes_list 查看全部Nod Read | nodes_get 在UUID上找到Nod Read | nodes_tags_list NOD标签列表Read | nodes_create 创建一个新的节点Write | nodes_update （更新Noda设置） | nodes_delete 删除Node Write | nodes_enable 写Noda | nodes_disable 关闭Noda Write | nodes_restart 重新启动Noda Write | nodes_restart_all 重新启动所有节点Write | nodes_reset_traffic 重置Noda流量Write | nodes_reorder 重写Noods Write | nodes_bulk_profile_modification –大规模更改Nod配置文件–Write› | nodes_bulk_actions #22312；大人物写作。 | nodes_bulk_update #22312；大更新，Write？

主机（11个工具）

工具描述模式 |------------|----------|-------| | hosts_list 所有主机列表Read | hosts_get UUID主机Read | hosts_tags_list 主机标签列表Read | hosts_create 创建新主机Write | hosts_update 更新主机设置 | hosts_delete 删除主机Write | hosts_bulk_enable #22312；多主机写作。 | hosts_bulk_disable 大规模停用主机Write | hosts_bulk_delete 大规模删除主机Write | hosts_bulk_set_inbound Inbound–Write→ | hosts_bulk_set_port 批量安装端口

系统（10个工具）

工具描述模式 |------------|----------|-------| | system_stats Ð面板统计（用户、节点、流量、CPU、内存）»阅读› | system_bandwidth_stats 带宽统计Read | system_nodes_metrics 诺德度量法Read | system_nodes_statistics 诺德统计Read | system_health 查看健康面板Read | system_metadata –面板的版本和元数据 | system_generate_x25519 x25519密钥对的生成 | auth_status 验证身份验证状态Read | system_stats_recap 统计资料Read | system_srr_matcher SRR路由规则测试

订阅（10个工具）

工具描述模式 |------------|----------|-------| | subscriptions_list 全部订阅列表Read | subscriptions_get_by_uuid UUID订阅Read | subscriptions_get_by_username 订阅User | subscriptions_get_by_short_uuid Short UUID的留言板Read | subscriptions_get_raw_by_short_uuid 首页»Short UUID»Read› | subscriptions_get_subpage_config 订阅子页面的配置 | subscriptions_get_connection_keys UUID连接键Read | subscription_info 订阅信息Read | subscription_request_history_list 订阅请求历史记录Read | subscription_request_history_stats 订阅请求统计（Read）

配置文件和输入（9个工具）

工具描述模式 |------------|----------|-------| | config_profiles_list 我的配置文件列表Read | config_profiles_get 我要用UUID获取配置文件 | inbounds_list 全部Inbounds Read | config_profiles_get_inbounds ÐÐÐÐÐÐÐÐÐÐÐÐÐ | config_profiles_get_computed_config ÐÐÐÐÐÐÐÐÐÐÐÐÐ | config_profiles_create ≫创建配置文件›Write› | config_profiles_update 更新配置文件 | config_profiles_delete 要删除配置文件，请写→ | config_profiles_reorder ≫重新配置配置文件›Write›

内部组（7个工具）

工具描述模式 |------------|----------|-------| | squads_list 集团名单Read | squads_accessible_nodes #22312；的团队成员Read？ | squads_create 创建一个团队Write | squads_update 更新组Write | squads_delete 删除组Write | squads_add_users 添加用户到组Write | squads_remove_users 从组中删除用户（Write）

HWID设备（7个工具）

工具描述模式 |------------|----------|-------| | hwid_devices_list 用户设备列表Read | hwid_devices_list_all 查看所有设备Read | hwid_stats HWID统计数据Read | hwid_top_users #22312；设备的用户，Read？ | hwid_device_create 创建HWID设备Write | hwid_device_delete 要删除特定设备，请写。 | hwid_devices_delete_all 删除所有用户设备（Write）

API令牌（3个工具）

工具描述模式 |------------|----------|-------| | api_tokens_list API令牌列表Read | api_tokens_create –创建API令牌–Write› | api_tokens_delete 要删除API令牌，请写。

注册机 （1 工具）

工具描述模式 |------------|----------|-------| | keygen_get 获取Keygen数据Read

基础设施计费（12个工具）

工具描述模式 |------------|----------|-------| | billing_providers_list 计费提供商列表Read | billing_provider_get UUID服务提供商Read | billing_nodes_list 我的计费节点列表Read | billing_history_list 比尔的故事Read | billing_provider_create 创建供应商Write | billing_provider_update 更新服务提供商Write | billing_provider_delete 删除服务提供商Write | billing_node_create 创建计费节点Write | billing_node_update 更新计费节点Write | billing_node_delete 删除计费节点（Write） | billing_history_create 写一个故事（Write） | billing_history_delete 删除历史记录Write

Snippets（4种乐器）

工具描述模式 |------------|----------|-------| | snippets_list 斯内普名单Read | snippets_create 要创建Snippet，Write | snippets_update 更新Snippet Write | snippets_delete 要删除Snippet，Write。

外部组（8个工具）

工具描述模式 |------------|----------|-------| | external_squads_list 外部团队列表Read | external_squads_get #22312；外的UUID团队Read？ | external_squads_create 创建一个外部团队（Write） | external_squads_update 更新外部组（Write） | external_squads_delete 删除外部组 | external_squads_add_users 添加用户Write | external_squads_remove_users 删除用户Write | external_squads_reorder 重写（Write）

设置（2个工具）

工具描述模式 |------------|----------|-------| | settings_get –获取面板设置 | settings_update ≫更新面板设置›写入›

订阅页面（7个工具）

工具描述模式 |------------|----------|-------| | sub_page_configs_list 页面列表Read | sub_page_configs_get 首页>Read | sub_page_configs_create 要创建页面配置，请写→ | sub_page_configs_update 更新页面配置 | sub_page_configs_delete 要删除页面配置，请写。 | sub_page_configs_reorder 重写（Write） | sub_page_configs_clone 克隆配置Write

Nod插件（11个工具）

工具描述模式 |------------|----------|-------| | node_plugins_list 插件列表Read | node_plugins_get UUID插件Read | node_plugins_torrent_reports 洪流封锁报告Read | node_plugins_torrent_stats 龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门龙门 | node_plugins_create 创建插件Write | node_plugins_update 更新插件Write | node_plugins_delete 删除插件Write | node_plugins_reorder 重写插件 | node_plugins_clone 克隆插件Write | node_plugins_execute 要运行插件（Write） | node_plugins_torrent_truncate ÐÐÐÐÐÐÐÐÐÐÐÐÐÐ

IP控制（5个工具）

工具描述模式 |------------|----------|-------| | ip_control_fetch_ips 获取用户IP Read | ip_control_get_fetch_ips_result IP查询结果Read | ip_control_fetch_users_ips 在Node上获取用户的IP Read | ip_control_get_fetch_users_ips_result 用户IP查询结果Read | ip_control_drop_connections 重置连接Write

元数据（4个工具）

工具描述模式 |------------|----------|-------| | metadata_node_get Noda元数据阅读 | metadata_user_get 获取用户元数据Read | metadata_node_upsert 更新Noda元数据 | metadata_user_upsert 更新用户元数据

资源

促销

#22312；的描述。 |--------|----------| | create_user_wizard 逐步创建用户 | node_diagnostics Noda的诊断 | traffic_report 交通报告 | user_audit 全面用户审核 | bulk_user_cleanup 搜索和管理过期用户

查询示例

«Покажи мне всех пользователей с истёкшей подпиской»
«Создай пользователя vasya с лимитом 50 ГБ на месяц»
«Перезапусти ноду amsterdam-01»
«Дай отчёт по трафику за последнюю неделю»
«Отключи пользователей, которые превысили лимит трафика»
«Какие ноды сейчас офлайн?»
«Покажи историю биллинга»
«Список плагинов нод»
«Получи IP-соединения пользователя X»

项目结构

src/
├── index.ts                       # Точка входа (stdio транспорт)
├── server.ts                      # Настройка McpServer
├── config.ts                      # Конфигурация окружения
├── client/
│   └── index.ts                   # HTTP-клиент Remnawave
├── tools/
│   ├── helpers.ts                 # Хелперы форматирования
│   ├── index.ts                   # Регистрация инструментов
│   ├── users.ts                   # Управление пользователями (27)
│   ├── nodes.ts                   # Управление нодами (15)
│   ├── hosts.ts                   # Управление хостами (11)
│   ├── system.ts                  # Система и авторизация (10)
│   ├── subscriptions.ts           # Подписки (10)
│   ├── inbounds.ts                # Конфиг-профили и inbounds (9)
│   ├── squads.ts                  # Внутренние группы (7)
│   ├── hwid.ts                    # HWID-устройства (7)
│   ├── infra-billing.ts           # Биллинг инфраструктуры (12)
│   ├── node-plugins.ts            # Плагины нод (11)
│   ├── external-squads.ts         # Внешние группы (8)
│   ├── subscription-page-configs.ts # Страницы подписок (7)
│   ├── ip-control.ts              # IP-контроль (5)
│   ├── snippets.ts                # Сниппеты (4)
│   ├── metadata.ts                # Метаданные нод и пользователей (4)
│   ├── api-tokens.ts              # API-токены (3)
│   ├── settings.ts                # Настройки панели (2)
│   └── keygen.ts                  # Keygen (1)
├── resources/
│   └── index.ts                   # MCP-ресурсы
└── prompts/
    └── index.ts                   # MCP-промпты

许可证

麻省理工学院