使用说明
项目简介
本项目是一个基于 Model Context Protocol (MCP) 的服务器实现,专注于提供 Grok-2 模型的图像生成能力。通过此服务器,LLM 客户端可以调用预定义的工具,向 Grok-2 模型发送文本提示,并获取生成的图像 URL。该服务器简化了 LLM 应用集成 Grok-2 图像生成功能的流程,使其能够以标准化的方式与外部图像生成服务交互。
主要功能点
- 图像生成工具: 提供 'generate_image' 工具,允许 LLM 客户端通过文本描述生成图像。
- 基于 MCP 协议: 遵循 MCP 协议标准,易于与任何兼容 MCP 协议的 LLM 客户端集成。
- 使用 Grok-2 模型: 后端采用 Grok-2 图像生成模型,保证图像生成质量。
- 环境变量配置: 通过环境变量 'XAIAPI_KEY' 和 'XAIAPI_BASE_URL' 配置 xAI API 密钥和基础 URL,方便灵活部署。
- 错误处理: 提供详细的错误处理机制,包括 API 请求失败、超时等情况,并返回友好的错误提示。
安装步骤
-
使用 npx 运行 (无需安装): 推荐使用 'npx' 直接运行该 MCP 服务器,无需全局安装。
npx -y grok2-image-mcp-server
服务器配置
对于 MCP 客户端,需要配置以下服务器信息以连接到 Grok-2 图像生成 MCP 服务器。
{ "mcpServers": { "grok2_image": { // 服务器名称,客户端用于标识和调用 "command": "npx", // 启动服务器的命令 "args": [ // 命令参数 "grok2-image-mcp-server" ], "env": { // 环境变量配置 "XAIAPI_KEY": "<在此处替换为您的 xAI API 密钥>", // 必须配置:xAI API 密钥 "XAIAPI_BASE_URL": "可选,例如:https://api.proxy.com/xai/v1" // 可选配置:xAI API 基础 URL,用于指定代理或非默认 API 地址 } } } }
配置说明:
- '"grok2_image"': 自定义的服务器名称,用于在 MCP 客户端中引用此服务器。
- '"command": "npx"' 和 '"args": ["grok2-image-mcp-server"]': 指定使用 'npx grok2-image-mcp-server' 命令启动服务器。
- '"env"': 配置服务器运行所需的环境变量。
- '"XAIAPI_KEY"': 必须替换 为您在 xAI 平台申请的 API 密钥。
- '"XAIAPI_BASE_URL"': 可选,如果需要使用代理或非官方 xAI API 地址,可以在这里配置。如果使用官方 xAI API,则无需配置此项。
基本使用方法
- 启动 MCP 服务器: 在终端中运行 'npx -y grok2-image-mcp-server' 命令启动 Grok-2 图像生成 MCP 服务器。服务器成功启动后,会在终端输出 'Grok2 Image MCP Server running on stdio' 提示信息。
- 配置 MCP 客户端: 在您的 MCP 客户端中,按照上述 "服务器配置" 代码块配置 'grok2_image' 服务器。确保正确填写 'XAIAPI_KEY'。
- 在 LLM 应用中调用 'generate_image' 工具: 在您的 LLM 应用中,当需要生成图像时,可以调用 'grok2_image' 服务器提供的 'generate_image' 工具,并提供图像描述文本作为 'prompt' 参数。服务器会将生成的图像 URL 返回给 LLM 客户端。
示例工具调用 (在 MCP 客户端中)
{ "jsonrpc": "2.0", "method": "tool/call", "params": { "tool_name": "generate_image", "arguments": { "prompt": "一只戴着帽子的猫咪在海边看日落" } }, "id": "123" }
服务器会调用 Grok-2 API 生成图像,并将包含图像 URL 的响应返回给客户端。
信息
分类
AI与计算