使用说明
项目简介
Ghost MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它充当 LLM 客户端和 Ghost CMS 内容管理系统之间的桥梁。通过此服务器,LLM 客户端可以利用 MCP 协议,以标准化的方式访问和操作 Ghost CMS 平台上的内容资源,例如文章、页面、会员信息等。
主要功能点
- 文章管理:支持文章的创建、读取、更新、删除和搜索功能。
- 页面管理:支持页面的创建、读取、更新和删除功能。
- 会员管理:支持会员的创建、读取、更新、删除和搜索功能。
- 标签和作者管理:支持标签和作者信息的读取。
- 图片上传:支持将图片上传到 Ghost CMS。
- 基于 MCP 协议:采用标准的 MCP 协议与客户端通信,提供稳定和可扩展的上下文服务。
安装步骤
- 安装 Node.js:确保你的系统已安装 Node.js (推荐 v18 或更高版本)。
- 安装 npm 包:在你的项目目录中,使用 npm 安装 Ghost MCP Server 包:
npm install @mtane0412/ghost-mcp-server - 配置 Ghost CMS Admin API 密钥:
-
登录你的 Ghost CMS 后台,进入 "Settings" -> "Integrations",创建一个新的 "Custom integration"。
-
创建后,你将获得一个 "Admin API key"。
-
设置以下环境变量,将 'YOUR_GHOST_URL' 替换为你的 Ghost CMS 地址,'YOUR_ADMIN_API_KEY' 替换为你获得的 API 密钥。
# macOS/Linux export GHOST_URL="YOUR_GHOST_URL" export GHOST_ADMIN_API_KEY="YOUR_ADMIN_API_KEY" # Windows (PowerShell) $env:GHOST_URL="YOUR_GHOST_URL" $env:GHOST_ADMIN_API_KEY="YOUR_ADMIN_API_KEY"或者,你也可以在项目根目录下创建 '.env' 文件,并写入以下内容:
GHOST_URL=YOUR_GHOST_URL GHOST_ADMIN_API_KEY=YOUR_ADMIN_API_KEY
-
服务器配置
MCP 客户端需要配置以下 JSON 信息以连接到 Ghost MCP Server:
{ "serverName": "Ghost Admin API Server", "command": "npx", "args": ["@mtane0412/ghost-mcp-server"] }
配置参数说明:
- 'serverName': MCP 服务器的名称,可以自定义,例如 "Ghost Admin API Server"。
- 'command': 启动 MCP 服务器的命令,这里使用 'npx' 来运行 npm 包。
- 'args': 传递给 'npx' 命令的参数,指定要运行的 npm 包 '@mtane0412/ghost-mcp-server'。
基本使用方法
-
启动服务器:在终端中运行以下命令启动 Ghost MCP Server:
npx @mtane0412/ghost-mcp-server服务器成功启动后,将通过 stdio 等待接收来自 MCP 客户端的请求。
-
使用 MCP 客户端:配置你的 MCP 客户端,使其连接到 Ghost MCP Server。客户端可以通过 JSON-RPC 协议调用服务器提供的工具 (Tools) 来管理 Ghost CMS 内容。
例如,客户端可以调用 'get_posts' 工具来获取文章列表,或调用 'create_post' 工具来创建新的文章。具体的工具列表和参数请参考仓库的 README 文档或 'src/tools/index.ts' 文件。
可用工具 (Tools)
服务器提供了以下工具,可以通过 MCP 客户端调用:
- 'get_posts': 获取文章列表
- 'get_post': 获取特定文章
- 'search_posts': 搜索文章
- 'create_post': 创建文章
- 'update_post': 更新文章
- 'delete_post': 删除文章
- 'get_post_by_slug': 根据 Slug 获取文章
- 'get_pages': 获取页面列表
- 'get_page': 获取特定页面
- 'create_page': 创建页面
- 'update_page': 更新页面
- 'delete_page': 删除页面
- 'get_page_by_slug': 根据 Slug 获取页面
- 'get_members': 获取会员列表
- 'get_member': 获取特定会员
- 'search_members': 搜索会员
- 'create_member': 创建会员
- 'update_member': 更新会员
- 'delete_member': 删除会员
- 'get_tags': 获取标签列表
- 'get_authors': 获取作者列表
- 'upload_image': 上传图片
每个工具的具体输入参数和功能描述,请参考仓库的 README.md 文件。
信息
分类
网页与API