feat: mcp server

This commit is contained in:
Jacky 2025-04-29 17:15:42 +08:00
parent c4a9d03bb3
commit e8ee931e16
No known key found for this signature in database
GPG key ID: 215C21B10DF38B4D
51 changed files with 2749 additions and 1526 deletions

View file

@ -0,0 +1,55 @@
# MCP 配置文件管理
## 简介
MCP 配置文件管理模块提供了一系列工具和资源,用于管理 Nginx 配置文件。这些功能允许 AI 代理和自动化工具执行各种配置文件操作,包括读取、创建、修改和组织配置文件。
## 功能列表
### 获取 Nginx 配置文件的根目录路径
- 类型:`tool`
- 名称:`nginx_config_base_path`
- 描述:获取 Nginx 配置文件的根目录路径
### 列出配置文件
- 类型:`tool`
- 名称:`nginx_config_list`
- 描述:获取指定目录下的配置文件和子目录列表
### 获取配置文件内容
- 类型:`tool`
- 名称:`nginx_config_get`
- 描述:读取指定配置文件的内容
### 添加新的配置文件
- 类型:`tool`
- 名称:`nginx_config_add`
- 描述:创建新的配置文件
### 修改现有配置文件
- 类型:`tool`
- 名称:`nginx_config_modify`
- 描述:更新现有配置文件的内容
### 重命名配置文件
- 类型:`tool`
- 名称:`nginx_config_rename`
- 描述:修改配置文件的名称或路径
### 创建配置目录
- 类型:`tool`
- 名称:`nginx_config_mkdir`
- 描述:创建新的配置目录
### 历史记录
- 类型:`tool`
- 名称:`nginx_config_history`
- 描述:获取配置文件的修改历史记录

View file

@ -0,0 +1,22 @@
# MCP Nginx 服务管理
## 简介
MCP Nginx 服务管理模块提供了一组工具和资源,用于监控和控制 Nginx 服务。这些功能使 AI 代理和自动化工具能够查询 Nginx 状态、重新加载配置和重启服务,而无需通过传统命令行界面。
## 功能列表
### 获取 Nginx 状态
- 类型:`tool`
- 名称:`nginx_status`
### 重新加载 Nginx
- 类型:`tool`
- 名称:`nginx_reload`
### 重启 Nginx 服务
- 类型:`tool`
- 名称:`nginx_restart`

43
docs/zh_CN/guide/mcp.md Normal file
View file

@ -0,0 +1,43 @@
# MCP 模块
## 简介
MCPModel Context Protocol是 Nginx UI 提供的一个特殊接口,允许 AI 代理与 Nginx UI 交互。通过 MCPAI 模型可以访问和管理 Nginx 配置文件、执行 Nginx 相关操作(如重启、重载)以及获取 Nginx 运行状态。
## 功能概览
MCP 模块主要分为两大部分功能:
- [配置文件管理](./mcp-config.md) - 管理 Nginx 配置文件的各种操作
- [Nginx 服务管理](./mcp-nginx.md) - 控制和监控 Nginx 服务状态
## 接口
MCP 接口通过 `/mcp` 路径提供 SSE 流式传输。
## 认证
MCP 接口通过 `node_secret` 查询参数进行认证。
例如:
```
http://localhost:9000/mcp?node_secret=<your_node_secret>
```
### 资源Resource
资源是 MCP 提供的可读取信息,例如 Nginx 状态。
### 工具Tool
工具是 MCP 提供的可执行操作,例如重启 Nginx、修改配置文件等。
## 使用场景
MCP 主要用于以下场景:
1. AI 驱动的 Nginx 配置管理
2. 自动化运维工具集成
3. 第三方系统与 Nginx UI 的集成
4. 提供机器可读的 API 以便于自动化脚本使用