更新README文件,增加HTTP模式支持的高级配置说明,提供详细的启动命令和客户端配置示例,同时简化了对支持MCP协议的AI应用的描述,以提升用户理解和使用体验。
This commit is contained in:
48
README_EN.md
48
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
|
||||
|
||||
<br/>
|
||||
|
||||
---
|
||||
@ -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`<br/>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.
|
||||
|
||||
Reference in New Issue
Block a user