From 0e49ef8a10535e6b126e30ae6ccc5da3521e59ee Mon Sep 17 00:00:00 2001 From: sean Date: Mon, 16 Jun 2025 15:51:38 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README=E6=96=87=E4=BB=B6?= =?UTF-8?q?=EF=BC=8C=E5=A2=9E=E5=8A=A0HTTP=E6=A8=A1=E5=BC=8F=E6=94=AF?= =?UTF-8?q?=E6=8C=81=E7=9A=84=E9=AB=98=E7=BA=A7=E9=85=8D=E7=BD=AE=E8=AF=B4?= =?UTF-8?q?=E6=98=8E=EF=BC=8C=E6=8F=90=E4=BE=9B=E8=AF=A6=E7=BB=86=E7=9A=84?= =?UTF-8?q?=E5=90=AF=E5=8A=A8=E5=91=BD=E4=BB=A4=E5=92=8C=E5=AE=A2=E6=88=B7?= =?UTF-8?q?=E7=AB=AF=E9=85=8D=E7=BD=AE=E7=A4=BA=E4=BE=8B=EF=BC=8C=E5=90=8C?= =?UTF-8?q?=E6=97=B6=E7=AE=80=E5=8C=96=E4=BA=86=E5=AF=B9=E6=94=AF=E6=8C=81?= =?UTF-8?q?MCP=E5=8D=8F=E8=AE=AE=E7=9A=84AI=E5=BA=94=E7=94=A8=E7=9A=84?= =?UTF-8?q?=E6=8F=8F=E8=BF=B0=EF=BC=8C=E4=BB=A5=E6=8F=90=E5=8D=87=E7=94=A8?= =?UTF-8?q?=E6=88=B7=E7=90=86=E8=A7=A3=E5=92=8C=E4=BD=BF=E7=94=A8=E4=BD=93?= =?UTF-8?q?=E9=AA=8C=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 58 +++++++++++++++++++++++++--------------------------- README_EN.md | 48 +++++++++++++++++++++---------------------- 2 files changed, 51 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index a469ea7..ad0169b 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,33 @@ PromptX 目前处于 **初始开发阶段**，我们正在积极完善功能和 > **💡 提示：** 配置中特意指定了官方镜像源 `registry.npmjs.org`，这可以避免因使用非官方镜像导致的安装问题。如果您发现安装很慢，建议使用代理工具加速，而不是切换到其他镜像源。 +### 🌐 **高级配置：HTTP 模式支持** + +除了上述本地模式外，PromptX 还支持 **HTTP 模式**，适用于远程部署或特殊网络环境： + +```bash +# 启动 HTTP 模式服务器 +npx -f -y dpml-prompt@beta mcp-server --transport http --port 3000 +``` + +然后在客户端配置中使用： +```json +{ + "mcpServers": { + "promptx": { + "url": "http://localhost:3000/mcp" + } + } +} +``` + +📖 **[完整安装配置指南](https://github.com/Deepractice/PromptX/wiki/PromptX-MCP-Install)** - 包含各种客户端的详细配置方法和故障排除 + + +### 不知道MCP是怎么？ [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb) + +目前所有支持 MCP 协议的 AI 客户端都可以使用 PromptX。主要包括：**Claude Desktop**、**Cursor**、**Windsurf**、**Cline**、**Zed**、**Continue** 等主流 AI 编程工具，以及更多正在接入中的应用。 + --- ### ⚙️ **工作原理** @@ -121,35 +148,6 @@ graph TD --- -### 不知道MCP怎么使用？ [点击查看 MCP幼儿园教程 BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb) - -#### **支持MCP的AI应用** - -| AI应用 | 状态 | 配置文件位置 | 特性 | -|--------|--------|-----------|------| -| **Claude Desktop** | ✅ 官方支持 | Windows: `%APPDATA%\Claude\claude_desktop_config.json`
macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` | Anthropic官方客户端，MCP原生支持 | -| **Cursor** | ✅ 支持 | 通过MCP设置面板配置 | 智能代码编辑器，开发者友好 | -| **Claude Code** | ✅ 支持 | `/home/user/.claude.json` 或者 `~/.claude.json` | Anthropic官方CLI工具，MCP原生支持，命令行AI编程助手 | -| **Windsurf** | ✅ 支持 | IDE内MCP配置面板 | Codeium推出的AI原生IDE | -| **Cline** | ✅ 支持 | VS Code插件配置 | 强大的AI编程助手 | -| **Augment** | ✅ 支持 | 桌面应用配置 | AI原生代码编辑器 | -| **Trae** | ✅ 支持 | IDE插件配置 | AI驱动的代码生成和重构工具 | -| **通义灵码** | 🟡 计划支持 | 阿里云IDE插件 | 阿里云推出的AI编程助手 | -| **Zed** | ✅ 支持 | 配置文件：`~/.config/zed/settings.json` | 高性能代码编辑器 | -| **Continue** | ✅ 支持 | VS Code插件配置 | VS Code AI助手插件 | -| **Replit Agent** | 🟡 实验支持 | Replit平台内置 | 在线编程环境 | -| **Jan** | 🟡 开发中 | 本地AI客户端 | 隐私优先的本地AI助手 | -| **Ollama WebUI** | 🟡 社区支持 | 第三方MCP适配器 | 本地大模型界面 | -| **Open WebUI** | 🟡 社区支持 | 插件系统 | 开源AI界面 | -| **百度 Comate** | 🟡 计划支持 | 百度IDE插件 | 百度推出的AI编程助手 | -| **腾讯 CodeWhisperer** | 🟡 计划支持 | 腾讯云IDE | 腾讯云AI编程工具 | - - -> **图例说明**： -> - ✅ **官方支持**：原生或通过官方插件支持MCP协议。 -> - 🟡 **实验/社区/计划支持**：通过社区插件、实验性功能或已列入开发计划。 -> - 更多AI应用正在接入... - **🎯 配置完成后，您的AI应用将自动获得6个专业工具：** - `promptx_init`: 🏗️ **系统初始化** - 自动准备工作环境。 - `promptx_hello`: 👋 **角色发现** - 浏览所有可用的专家角色。 @@ -187,7 +185,7 @@ graph TD #### **📚 相关资源** -- **AI集成标准与实践指南：** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHC N.md +- **AI集成标准与实践指南：** https://github.com/LegacyLands/legacy-lands-library/blob/main/AI_CODE_STANDARDS_ZHCN.md --- diff --git a/README_EN.md b/README_EN.md index 055caf8..00d0d03 100644 --- a/README_EN.md +++ b/README_EN.md @@ -88,6 +88,28 @@ Open your configuration file and copy the `promptx` configuration code below. Th > **💡 Tip:** The configuration specifically uses the official registry `registry.npmjs.org` to avoid installation issues caused by unofficial mirrors. If you find the installation slow, it's recommended to use a proxy tool for acceleration rather than switching to alternative mirrors. +### 🌐 **Advanced Configuration: HTTP Mode Support** + +In addition to the local mode above, PromptX also supports **HTTP mode**, suitable for remote deployment or special network environments: + +```bash +# Start HTTP mode server +npx -f -y dpml-prompt@beta mcp-server --transport http --port 3000 +``` + +Then use in client configuration: +```json +{ + "mcpServers": { + "promptx": { + "url": "http://localhost:3000/mcp" + } + } +} +``` + +📖 **[Complete Installation & Configuration Guide](https://github.com/Deepractice/PromptX/wiki/PromptX-MCP-Install)** - Detailed configuration methods for various clients and troubleshooting +
--- @@ -125,31 +147,7 @@ When you call the `promptx_...` series of tools, your AI application sends the r ### New to MCP? [Watch MCP Tutorial on BiliBili](https://www.bilibili.com/video/BV1HFd6YhErb) -#### **Supported AI Applications** - -| Application | Status | Configuration | Notes | -|-------------|--------|---------------|-------| -| **Claude Desktop** | ✅ Official | Windows: `%APPDATA%\Claude\claude_desktop_config.json`
macOS: `~/Library/Application Support/Claude/claude_desktop_config.json` | Anthropic's official client with native MCP support | -| **Cursor** | ✅ Supported | MCP settings panel | Developer-friendly code editor | -| **Claude Code** | ✅ Supported | `/home/user/.claude.json` or `~/.claude.json` | Anthropic's official CLI tool with native MCP support, command-line AI programming assistant | -| **Windsurf** | ✅ Supported | IDE MCP panel | Codeium's AI-native IDE | -| **Cline** | ✅ Supported | VS Code plugin config | Powerful AI programming assistant | -| **Augment** | ✅ Supported | Desktop app config | AI-native code editor | -| **Trae** | ✅ Supported | IDE plugin config | AI-driven code generation tool | -| **通义灵码** | 🟡 Planned | Alibaba Cloud IDE plugin | Alibaba's AI programming assistant | -| **Zed** | ✅ Supported | Config: `~/.config/zed/settings.json` | High-performance code editor | -| **Continue** | ✅ Supported | VS Code plugin config | VS Code AI assistant plugin | -| **Replit Agent** | 🟡 Experimental | Built into Replit platform | Online programming environment | -| **Jan** | 🟡 In Development | Local AI client | Privacy-first local AI assistant | -| **Ollama WebUI** | 🟡 Community | Third-party MCP adapter | Local model interface | -| **Open WebUI** | 🟡 Community | Plugin system | Open source AI interface | -| **百度 Comate** | 🟡 Planned | Baidu IDE plugin | Baidu's AI programming assistant | -| **腾讯 CodeWhisperer** | 🟡 Planned | Tencent Cloud IDE | Tencent's AI programming tool | - -> **Legend**: -> - ✅ **Official Support**: Native or official plugin support for MCP protocol. -> - 🟡 **Experimental/Community/Planned Support**: Support through community plugins, experimental features, or in development plans. -> - More AI applications are integrating MCP protocol... +All AI clients that support the MCP protocol can use PromptX. This includes major applications like **Claude Desktop**, **Cursor**, **Windsurf**, **Cline**, **Zed**, **Continue**, and many more mainstream AI development tools that are integrating MCP support. **🎯 After configuration, your AI application will automatically gain 6 professional tools:** - `promptx_init`: 🏗️ **System Initialization** - Automatically prepares the working environment.