diff --git a/README.md b/README.md index 9cafeea..ffca7ab 100644 --- a/README.md +++ b/README.md @@ -70,22 +70,30 @@ PromptX 目前处于 **初始开发阶段**,我们正在积极完善功能和 { "mcpServers": { "promptx": { - // 指定使用 npx 运行 promptx 服务 "command": "npx", - // 启动参数配置 "args": [ - "-y", // 自动确认 - "-f", // 强制刷新缓存 - "--registry", // 指定镜像源 - "https://registry.npmjs.org", // 使用官方镜像 - "dpml-prompt@beta", // 使用稳定测试版 - "mcp-server" // 启动服务 + "-y", + "-f", + "--registry", + "https://registry.npmjs.org", + "dpml-prompt@beta", + "mcp-server" ] } } } ``` +**配置参数说明:** +- `command`: 指定使用 npx 运行 promptx 服务 +- `args`: 启动参数配置列表 + - `-y`: 自动确认 + - `-f`: 强制刷新缓存 + - `--registry`: 指定镜像源 + - `https://registry.npmjs.org`: 使用官方镜像 + - `dpml-prompt@beta`: 使用稳定测试版 + - `mcp-server`: 启动服务 + **🎯 就这么简单!** 保存文件并重启您的AI应用,PromptX 就已成功激活。 > **💡 提示:** 配置中特意指定了官方镜像源 `registry.npmjs.org`,这可以避免因使用非官方镜像导致的安装问题。如果您发现安装很慢,建议使用代理工具加速,而不是切换到其他镜像源。 diff --git a/README_EN.md b/README_EN.md index e2e237f..b66f2b9 100644 --- a/README_EN.md +++ b/README_EN.md @@ -70,22 +70,30 @@ Open your configuration file and copy the `promptx` configuration code below. Th { "mcpServers": { "promptx": { - // Use npx to run promptx service "command": "npx", - // Startup parameters configuration "args": [ - "-y", // Auto-confirm - "-f", // Force refresh cache - "--registry", // Specify registry - "https://registry.npmjs.org", // Use official registry - "dpml-prompt@beta", // Use stable beta version - "mcp-server" // Start service + "-y", + "-f", + "--registry", + "https://registry.npmjs.org", + "dpml-prompt@beta", + "mcp-server" ] } } } ``` +**Configuration Parameters:** +- `command`: Specifies using npx to run promptx service +- `args`: Startup parameters configuration list + - `-y`: Auto-confirm + - `-f`: Force refresh cache + - `--registry`: Specify registry source + - `https://registry.npmjs.org`: Use official registry + - `dpml-prompt@beta`: Use stable beta version + - `mcp-server`: Start service + **🎯 It's that simple!** Save the file and restart your AI application, and PromptX is successfully activated. > **💡 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.