使用说明
项目简介
Wordware MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它允许您在本地运行 Wordware AI 应用,并将这些应用的功能以 MCP 工具的形式暴露给支持 MCP 协议的客户端,例如 Claude Desktop。通过此服务器,您可以方便地将 Wordware 强大的 AI 工作流集成到本地开发环境或与支持 MCP 的应用进行交互。
主要功能点
- Wordware 应用集成: 将您在 Wordware 平台上创建和部署的 AI 应用转化为 MCP 工具。
- 本地 MCP 服务器: 在本地运行 MCP 服务器,无需依赖云端服务,方便开发和测试。
- 工具注册与发现: 自动将 Wordware 应用注册为 MCP 工具,并支持客户端发现和调用。
- Claude Desktop 集成: 提供与 Claude Desktop 桌面应用的无缝集成,允许 Claude 调用 Wordware 应用的功能。
- 灵活配置: 支持通过环境变量、.env 文件或命令行参数进行配置。
- 交互式安装: 提供 'npx wordware-mcp' 交互式安装过程,简化配置。
安装步骤
-
安装 Node.js 和 npm: 确保您的系统已安装 Node.js 和 npm。
-
使用 npx 交互式安装 (推荐): 打开终端并运行以下命令,按照提示完成安装:
npx wordware-mcp此命令将引导您输入 Wordware API 密钥、应用 ID,并可选配置 Claude Desktop。
-
手动安装: 您也可以选择手动安装:
- 全局安装:
npm install -g wordware-mcp - 本地安装 (在项目中使用):
npm install wordware-mcp - 从 GitHub 克隆并全局安装:
git clone https://github.com/yuhuangou/wordware-mcp.git cd wordware-mcp npm run install-global
- 全局安装:
服务器配置
MCP 服务器主要通过环境变量或 '.env' 文件进行配置。对于 MCP 客户端(例如 Claude Desktop),您需要配置 MCP 服务器的启动命令。
Claude Desktop 客户端配置示例 (claude_desktop_config.json):
{ "mcpServers": { "wordware": { "command": "wordware-mcp-server" // MCP 服务器启动命令,全局安装时使用 wordware-mcp-server,本地安装或直接运行时可能需要使用 'node build/index.js' 或 'node index.js' (取决于您的安装和运行方式) } } }
参数说明:
- 'server name': 'wordware',服务器名称,在客户端配置中用于标识。
- 'command': 'wordware-mcp-server',启动 Wordware MCP Server 的命令。如果您是全局安装的 'wordware-mcp' 包,可以直接使用 'wordware-mcp-server'。如果不是全局安装,或者您在项目目录中运行,则可能需要指定 Node.js 执行路径,例如 'node build/index.js' 或 'node index.js' (取决于您的构建输出路径)。
- 'args': 此处不需要额外参数,配置信息主要通过环境变量或 '.env' 文件传递。
环境变量或 .env 文件配置 (可选):
在 MCP 服务器运行的目录下创建 '.env' 文件,或设置环境变量,配置 Wordware API 密钥和应用 ID:
WORDWARE_API_KEY=您的Wordware_API密钥 APP_IDS=您的Wordware应用ID1,您的Wordware应用ID2 # 多个应用ID用逗号分隔 PORT=3000 # (可选) 服务器端口,默认为 3000
您也可以通过命令行参数配置 API 密钥和应用 ID,具体请参考仓库 README 文档。
基本使用方法
-
启动 MCP 服务器: 全局安装时,在终端运行:
wordware-mcp-server或者,如果您在项目中使用或本地安装,请根据您的安装方式和 'package.json' 中的脚本运行。
-
配置 MCP 客户端: 以 Claude Desktop 为例,按照上述 服务器配置 部分修改 'claude_desktop_config.json' 文件,配置 'wordware' 服务器,并确保 'command' 配置正确指向您的 Wordware MCP Server 启动命令。
-
在 MCP 客户端中使用 Wordware 工具: 启动 Claude Desktop (或您使用的 MCP 客户端),客户端应该能够自动发现并列出 Wordware MCP 服务器提供的工具。您可以在客户端中像使用其他工具一样调用这些 Wordware 工具,从而利用 Wordware 应用的功能。
注意:
- 确保您已在 wordware.ai 注册账号并创建了 API 密钥。
- 您需要在 Wordware 平台上创建并部署至少一个应用,并获取 'app_id'。
- 详细配置和高级用法请参考仓库 README 文档和源代码。
信息
分类
AI与计算