PiAPI MCP Server 使用说明
项目简介
PiAPI MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它允许大型语言模型 (LLM) 客户端(如 Claude Desktop)通过 MCP 协议调用 PiAPI 提供的图像生成服务。用户可以使用文本描述通过 Flux 模型生成图像。
主要功能点
- 文生图: 通过文本描述,使用 PiAPI 提供的 Flux 模型生成图像。
- MCP 协议支持: 实现了 MCP 协议,可以与任何兼容 MCP 协议的 LLM 客户端(如 Claude Desktop)进行通信。
- PiAPI 集成: 无缝集成了 PiAPI 服务,利用 PiAPI 的 API 密钥进行身份验证和图像生成任务。
安装步骤
- 克隆仓库: 在您的本地计算机上克隆 PiAPI MCP Server 仓库:
git clone https://github.com/apinetwork/piapi-mcp-server - 进入目录: 使用 'cd' 命令进入克隆下来的仓库目录:
cd piapi-mcp-server - 安装依赖: 运行 'npm install' 命令安装项目所需的依赖包:
npm install - 配置 API 密钥: 在项目根目录下创建 '.env' 文件,并在文件中设置 PiAPI API 密钥。您需要访问 PiAPI 官网 获取 API 密钥。
PIAPI_API_KEY=your_api_key_here - 构建项目: 运行 'npm run build' 命令编译 TypeScript 代码:
npm run build
服务器配置
要将 PiAPI MCP Server 连接到 MCP 客户端(例如 Claude Desktop),您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude Desktop 的配置示例,您可以根据您的 MCP 客户端进行调整。
将以下 JSON 配置添加到 Claude Desktop 的配置文件 ('~/Library/Application Support/Claude/claude_desktop_config.json' on macOS 或 '%APPDATA%\Claude\claude_desktop_config.json' on Windows) 的 'mcpServers' 字段中:
{ "mcpServers": { "piapi": { // 服务器名称,您可以自定义,例如 "piapi-image-server" "command": "node", // 启动服务器的命令,通常为 node "args": ["/absolute/path/to/piapi-mcp-server/dist/index.js"] // 启动服务器的参数,指向编译后的 index.js 文件,**请务必替换为实际路径** } } }
注意: 请将 '/absolute/path/to/piapi-mcp-server/dist/index.js' 替换为 'piapi-mcp-server/dist/index.js' 文件在您本地文件系统中的绝对路径。您可以使用终端命令 'pwd' 获取当前目录的绝对路径,然后在该路径后追加 'piapi-mcp-server/dist/index.js' 即可得到完整的文件路径。
基本使用方法
- 启动服务器: 在 'piapi-mcp-server' 仓库目录下,运行以下命令启动 PiAPI MCP Server:
服务器默认使用 'stdio' 传输协议,并在控制台输出日志信息。npm start - 连接 MCP 客户端: 根据您使用的 MCP 客户端的文档,配置连接到 PiAPI MCP Server。对于 Claude Desktop,您已在 “服务器配置” 步骤中完成配置。
- 在 MCP 客户端中使用: 在 MCP 客户端中,您现在应该可以使用 'generate_image' 工具。在与 LLM 的对话中,您可以指示 LLM 使用 'generate_image' 工具并提供文本描述,PiAPI MCP Server 将会调用 PiAPI 服务生成图像并返回结果。
信息
分类
AI与计算