diff --git a/README.md b/README.md index e8e06ac..3ea1967 100644 --- a/README.md +++ b/README.md @@ -527,6 +527,29 @@ AI驱动的开源代码知识库与文档协作平台,支持多模型、多数 + + + + + + +
+ + +MCP Inspector +
MCP Inspector +
+ +🔍 模型上下文协议调试工具,支持MCP服务器测试与开发 + +0.16.2 • [官网链接](https://github.com/modelcontextprotocol/inspector) + +
+ + + +
+ #### 🎵 多媒体管理 diff --git a/apps/inspector/0.16.2/data.yml b/apps/inspector/0.16.2/data.yml new file mode 100644 index 0000000..dede2e8 --- /dev/null +++ b/apps/inspector/0.16.2/data.yml @@ -0,0 +1,50 @@ +additionalProperties: + formFields: + - default: 6274 + envKey: PANEL_APP_PORT_HTTP + labelEn: Web UI Port + labelZh: Web界面端口 + label: + en: Web UI Port + zh: Web界面端口 + zh-Hant: Web界面埠 + required: true + rule: paramPort + type: number + - default: 6277 + envKey: PANEL_APP_PORT_PROXY + labelEn: Proxy Port + labelZh: 代理端口 + label: + en: Proxy Port + zh: 代理端口 + zh-Hant: 代理埠 + required: true + rule: paramPort + type: number + - default: "" + envKey: DANGEROUSLY_OMIT_AUTH + labelEn: Disable Authentication + labelZh: 禁用身份验证 (默认不选择则不禁用) + label: + en: Disable Authentication + zh: 禁用身份验证 (默认不选择则不禁用) + zh-Hant: 禁用身份驗證 + required: false + type: select + values: + - label: "True" + value: "true" + - label: "False" + value: "" + - default: "" + envKey: MCP_PROXY_AUTH_TOKEN + labelEn: Proxy Auth Token (openssl rand -hex 32) + labelZh: 代理认证令牌 (使用命令openssl rand -hex 32生成) + label: + en: Proxy Auth Token (openssl rand -hex 32) + zh: 代理认证令牌 (使用命令openssl rand -hex 32生成) + zh-Hant: 代理認證令牌 + random: false + required: false + type: text diff --git a/apps/inspector/0.16.2/docker-compose.yml b/apps/inspector/0.16.2/docker-compose.yml new file mode 100644 index 0000000..87a7b2f --- /dev/null +++ b/apps/inspector/0.16.2/docker-compose.yml @@ -0,0 +1,21 @@ +services: + inspector: + image: ghcr.io/modelcontextprotocol/inspector:0.16.2 + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - ${PANEL_APP_PORT_HTTP}:6274 + - ${PANEL_APP_PORT_PROXY}:6277 + environment: + - NODE_ENV=production + - DANGEROUSLY_OMIT_AUTH=${DANGEROUSLY_OMIT_AUTH} + - MCP_PROXY_AUTH_TOKEN=${MCP_PROXY_AUTH_TOKEN:-} + - HOST=0.0.0.0 + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true \ No newline at end of file diff --git a/apps/inspector/README.md b/apps/inspector/README.md new file mode 100644 index 0000000..c7a407d --- /dev/null +++ b/apps/inspector/README.md @@ -0,0 +1,101 @@ +# MCP Inspector + +MCP Inspector 是一个用于测试和调试 Model Context Protocol (MCP) 服务器的开发工具,提供直观的 Web UI 界面和命令行接口,帮助开发者探索和测试 MCP 服务器的功能。 + +![](https://cdn.jsdelivr.net/gh/xiaoY233/PicList@main/public/assets/MCP-Inspector.png) + +![](https://img.shields.io/badge/Copyright-arch3rPro-ff9800?style=flat&logo=github&logoColor=white) + +## 🚀 主要功能 + +- **🔌 连接管理** - 建立并维护与 MCP 服务器的连接 +- **🔍 能力探索** - 发现和测试服务器的能力,例如工具、资源和提示 +- **🔐 认证处理** - 支持 OAuth 流程和 Bearer Token 认证 +- **📊 请求/响应检查** - 显示详细的 MCP 协议交互 +- **⚙️ 配置管理** - 持久化用户设置和连接参数 +- **💻 CLI 模式** - 提供命令行接口,用于自动化、脚本编写以及与 AI 编码助手的集成 + +## 💻 系统要求 + +- **内存**: 至少 1GB RAM +- **存储**: 至少 500MB 可用空间 +- **网络**: 需要互联网连接以访问 MCP 服务器 + +## 🔧 使用方法 + +1. 在1Panel中安装应用后,配置以下参数: + - Web界面端口:默认为6274,可根据需要更改 + +2. 启动应用后,通过浏览器访问 `http://您的IP:端口` + +3. 在 Web UI 中配置 MCP 服务器连接信息: + - 输入 MCP 服务器的 URL + - 选择认证类型(无认证、Bearer Token 或 OAuth) + - 配置相应的认证信息 + +4. 使用界面探索和测试 MCP 服务器的功能: + - 查看可用的工具和资源 + - 发送请求并查看响应 + - 调试 MCP 协议交互 + +## 🔍 功能详解 + +### 连接管理 + +MCP Inspector 允许您连接到任何兼容 MCP 协议的服务器。您可以: + +- 保存多个服务器配置 +- 快速切换不同的服务器 +- 测试连接状态和响应时间 + +### 能力探索 + +探索 MCP 服务器提供的各种能力: + +- 查看可用的工具列表及其参数 +- 浏览可访问的资源 +- 测试提示模板 + +### 认证处理 + +支持多种认证方式: + +- 无认证模式 +- Bearer Token 认证 +- 完整的 OAuth 流程,包括授权和令牌刷新 + +### 请求/响应检查 + +详细分析 MCP 协议交互: + +- 查看原始请求和响应 +- 格式化 JSON 数据 +- 追踪请求时间线 + +## 🛠️ 配置选项 + +MCP Inspector 提供了多种配置选项,可以通过 `config.yaml` 文件进行设置: + +```yaml +# 服务器设置 +server: + port: 3000 + https: false + +# 客户端设置 +client: + defaultConnection: + url: "http://localhost:8000" + authType: "none" + +# 日志设置 +logging: + level: "info" + console: true +``` + +## 📚 更多信息 + +- [GitHub 仓库](https://github.com/modelcontextprotocol/inspector) +- [Model Context Protocol 规范](https://github.com/modelcontextprotocol/spec) +- [MCP 开发者文档](https://github.com/modelcontextprotocol/inspector/wiki) \ No newline at end of file diff --git a/apps/inspector/README_en.md b/apps/inspector/README_en.md new file mode 100644 index 0000000..926d1a8 --- /dev/null +++ b/apps/inspector/README_en.md @@ -0,0 +1,101 @@ +# MCP Inspector + +MCP Inspector is a development tool for testing and debugging Model Context Protocol (MCP) servers, providing an intuitive Web UI interface and command-line interface to help developers explore and test MCP server functionality. + +![](https://cdn.jsdelivr.net/gh/xiaoY233/PicList@main/public/assets/MCP-Inspector.png) + +![](https://img.shields.io/badge/Copyright-arch3rPro-ff9800?style=flat&logo=github&logoColor=white) + +## 🚀 Key Features + +- **🔌 Connection Management** - Establish and maintain connections to MCP servers +- **🔍 Capability Exploration** - Discover and test server capabilities such as tools, resources, and prompts +- **🔐 Authentication Handling** - Support for OAuth flows and Bearer Token authentication +- **📊 Request/Response Inspection** - Display detailed MCP protocol interactions +- **⚙️ Configuration Management** - Persist user settings and connection parameters +- **💻 CLI Mode** - Provide command-line interface for automation, scripting, and integration with AI coding assistants + +## 💻 System Requirements + +- **Memory**: At least 1GB RAM +- **Storage**: At least 500MB available space +- **Network**: Internet connection required to access MCP servers + +## 🔧 Usage + +1. After installing the application in 1Panel, configure the following parameters: + - Web UI Port: Default is 6274, can be changed as needed + +2. After starting the application, access the Web UI via `http://your-ip:port` + +3. Configure MCP server connection information in the Web UI: + - Enter the MCP server URL + - Select authentication type (None, Bearer Token, or OAuth) + - Configure the corresponding authentication information + +4. Use the interface to explore and test MCP server functionality: + - View available tools and resources + - Send requests and view responses + - Debug MCP protocol interactions + +## 🔍 Feature Details + +### Connection Management + +MCP Inspector allows you to connect to any server compatible with the MCP protocol. You can: + +- Save multiple server configurations +- Quickly switch between different servers +- Test connection status and response time + +### Capability Exploration + +Explore various capabilities provided by MCP servers: + +- View list of available tools and their parameters +- Browse accessible resources +- Test prompt templates + +### Authentication Handling + +Support for multiple authentication methods: + +- No authentication mode +- Bearer Token authentication +- Complete OAuth flow, including authorization and token refresh + +### Request/Response Inspection + +Detailed analysis of MCP protocol interactions: + +- View raw requests and responses +- Format JSON data +- Track request timeline + +## 🛠️ Configuration Options + +MCP Inspector provides various configuration options that can be set through the `config.yaml` file: + +```yaml +# Server settings +server: + port: 3000 + https: false + +# Client settings +client: + defaultConnection: + url: "http://localhost:8000" + authType: "none" + +# Logging settings +logging: + level: "info" + console: true +``` + +## 📚 More Information + +- [GitHub Repository](https://github.com/modelcontextprotocol/inspector) +- [Model Context Protocol Specification](https://github.com/modelcontextprotocol/spec) +- [MCP Developer Documentation](https://github.com/modelcontextprotocol/inspector/wiki) \ No newline at end of file diff --git a/apps/inspector/data.yml b/apps/inspector/data.yml new file mode 100644 index 0000000..6e6f7f2 --- /dev/null +++ b/apps/inspector/data.yml @@ -0,0 +1,29 @@ +name: MCP Inspector +tags: + - AI / 大模型 + - 开发工具 +title: Model Context Protocol (MCP) 服务器调试工具 +description: MCP Inspector 是一个用于测试和调试 Model Context Protocol (MCP) 服务器的开发工具,提供直观的 Web UI 界面和命令行接口,支持连接管理、能力探索和请求/响应检查等功能。 +additionalProperties: + key: inspector + name: MCP Inspector + tags: + - AI + - 开发工具 + shortDescZh: MCP 服务器测试与调试工具 + shortDescEn: Testing and debugging tool for MCP servers + type: website + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://github.com/modelcontextprotocol/inspector + github: https://github.com/modelcontextprotocol/inspector + document: https://github.com/modelcontextprotocol/inspector + description: + en: A development tool for testing and debugging Model Context Protocol (MCP) servers, featuring a React-based Web UI client and a Node.js proxy server + zh: 用于测试和调试 Model Context Protocol (MCP) 服务器的开发工具,包含基于 React 的 Web UI 客户端和 Node.js 代理服务器 + zh-Hant: 用於測試和調試 Model Context Protocol (MCP) 服務器的開發工具,包含基於 React 的 Web UI 客戶端和 Node.js 代理服務器 + memoryRequired: 1024 + architectures: + - amd64 + - arm64 \ No newline at end of file diff --git a/apps/inspector/latest/data.yml b/apps/inspector/latest/data.yml new file mode 100644 index 0000000..dede2e8 --- /dev/null +++ b/apps/inspector/latest/data.yml @@ -0,0 +1,50 @@ +additionalProperties: + formFields: + - default: 6274 + envKey: PANEL_APP_PORT_HTTP + labelEn: Web UI Port + labelZh: Web界面端口 + label: + en: Web UI Port + zh: Web界面端口 + zh-Hant: Web界面埠 + required: true + rule: paramPort + type: number + - default: 6277 + envKey: PANEL_APP_PORT_PROXY + labelEn: Proxy Port + labelZh: 代理端口 + label: + en: Proxy Port + zh: 代理端口 + zh-Hant: 代理埠 + required: true + rule: paramPort + type: number + - default: "" + envKey: DANGEROUSLY_OMIT_AUTH + labelEn: Disable Authentication + labelZh: 禁用身份验证 (默认不选择则不禁用) + label: + en: Disable Authentication + zh: 禁用身份验证 (默认不选择则不禁用) + zh-Hant: 禁用身份驗證 + required: false + type: select + values: + - label: "True" + value: "true" + - label: "False" + value: "" + - default: "" + envKey: MCP_PROXY_AUTH_TOKEN + labelEn: Proxy Auth Token (openssl rand -hex 32) + labelZh: 代理认证令牌 (使用命令openssl rand -hex 32生成) + label: + en: Proxy Auth Token (openssl rand -hex 32) + zh: 代理认证令牌 (使用命令openssl rand -hex 32生成) + zh-Hant: 代理認證令牌 + random: false + required: false + type: text diff --git a/apps/inspector/latest/docker-compose.yml b/apps/inspector/latest/docker-compose.yml new file mode 100644 index 0000000..1bf0246 --- /dev/null +++ b/apps/inspector/latest/docker-compose.yml @@ -0,0 +1,21 @@ +services: + inspector: + image: ghcr.io/modelcontextprotocol/inspector:latest + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - ${PANEL_APP_PORT_HTTP}:6274 + - ${PANEL_APP_PORT_PROXY}:6277 + environment: + - NODE_ENV=production + - DANGEROUSLY_OMIT_AUTH=${DANGEROUSLY_OMIT_AUTH} + - MCP_PROXY_AUTH_TOKEN=${MCP_PROXY_AUTH_TOKEN:-} + - HOST=0.0.0.0 + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true \ No newline at end of file diff --git a/apps/inspector/logo.png b/apps/inspector/logo.png new file mode 100644 index 0000000..45ebd13 Binary files /dev/null and b/apps/inspector/logo.png differ