使用说明

@8ux co/eelzap mcp服务器

将您的AI助手连接到 Eel Zap CMS。创建收藏、管理内容、上传媒体和发布——所有这些都是通过自然语言完成的。

适用于Claude Code、Cursor、VS Code、Codex和Claude Desktop。

快速开始

使用CLI（推荐）：

npx @8ux-co/eelzap-mcp-server install

使用克劳德代码：

claude mcp add --transport stdio eelzap \
  --env EELZAP_API_KEY=secret_your_key_here \
  -- npx -y @8ux-co/eelzap-mcp-server

有关其他工具，请参阅安装指南在......下面

安装指南

克劳德代码

CLI方法：

npx @8ux-co/eelzap-mcp-server install --tool claude-code

手动方法——项目范围(.mcp.json):

创建 .mcp.json 在项目根目录中：

{
  "mcpServers": {
    "eelzap": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@8ux-co/eelzap-mcp-server"],
      "env": {
        "EELZAP_API_KEY": "secret_your_key_here"
      }
    }
  }
}

手动方法——用户范围(~/.claude.json):

添加到 mcpServers 部分 ~/.claude.json:

{
  "mcpServers": {
    "eelzap": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@8ux-co/eelzap-mcp-server"],
      "env": {
        "EELZAP_API_KEY": "secret_your_key_here"
      }
    }
  }
}

使用 claude mcp add:

claude mcp add --transport stdio eelzap \
  --env EELZAP_API_KEY=secret_your_key_here \
  -- npx -y @8ux-co/eelzap-mcp-server

光标

CLI方法：

npx @8ux-co/eelzap-mcp-server install --tool cursor

手动方法——项目范围：

创建 .cursor/mcp.json 在项目根目录中：

{
  "mcpServers": {
    "eelzap": {
      "command": "npx",
      "args": ["-y", "@8ux-co/eelzap-mcp-server"],
      "env": {
        "EELZAP_API_KEY": "secret_your_key_here"
      }
    }
  }
}

手动方法——全局范围：

创建或编辑 ~/.cursor/mcp.json 具有相同的结构。

VS代码

CLI方法：

npx @8ux-co/eelzap-mcp-server install --tool vscode

手动方法：

创建 .vscode/mcp.json 在项目根目录中：

{
  "servers": {
    "eelzap": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@8ux-co/eelzap-mcp-server"],
      "env": {
        "EELZAP_API_KEY": "secret_your_key_here"
      }
    }
  }
}

重要提示： VS代码使用 "servers" 作为顶级密钥，不是 "mcpServers".

法典

CLI方法：

npx @8ux-co/eelzap-mcp-server install --tool codex

手动方法：

添加 ~/.codex/config.toml （或 .codex/config.toml 项目范围）：

[mcp_servers.eelzap]
command = "npx"
args = ["-y", "@8ux-co/eelzap-mcp-server"]
enabled = true

[mcp_servers.eelzap.env]
EELZAP_API_KEY = "secret_your_key_here"

克劳德桌面

CLI方法：

npx @8ux-co/eelzap-mcp-server install --tool claude-desktop

手动方法：

在以下位置编辑配置文件：

macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
窗户： %APPDATA%\Claude\claude_desktop_config.json
Linux： ~/.config/claude/claude_desktop_config.json

添加到 mcpServers 章节：

{
  "mcpServers": {
    "eelzap": {
      "command": "npx",
      "args": ["-y", "@8ux-co/eelzap-mcp-server"],
      "env": {
        "EELZAP_API_KEY": "secret_your_key_here"
      }
    }
  }
}

保存后重新启动Claude Desktop。

CLI命令

命令	描述
`npx @8ux-co/eelzap-mcp-server install`	任何支持工具的交互式设置
`npx @8ux-co/eelzap-mcp-server switch-key`	更改现有安装的API密钥
`npx @8ux-co/eelzap-mcp-server uninstall`	从工具的配置中删除eelzap条目
`npx @8ux-co/eelzap-mcp-server status`	显示所有检测到的安装及其连接状态
`npx @8ux-co/eelzap-mcp-server doctor`	诊断常见的配置问题

示例：

# Install with flags (non-interactive):
npx @8ux-co/eelzap-mcp-server install \
  --tool claude-code \
  --scope project \
  --api-key secret_xxx

# Update the API key for a specific tool:
npx @8ux-co/eelzap-mcp-server switch-key --tool cursor

# Check what's configured and whether it's working:
npx @8ux-co/eelzap-mcp-server status

# Run diagnostics:
npx @8ux-co/eelzap-mcp-server doctor

配置

环境变量

变量	必填	默认	描述
`EELZAP_API_KEY`	是	-	您的API密钥。开始于 `secret_` （完全访问）或 `public_` （只读）。从“设置”>“API密钥”下的Eel Zap仪表板中获取。
`EELZAP_BASE_URL`	没有	`https://api.eelzap.com`	API基本URL。用于自托管或本地开发的覆盖。
`EELZAP_PATH_PREFIX`	没有	`/v1`	路径前缀。设置为 `/api/public/v1` 针对Next.js开发服务器的本地开发。

API密钥类型

密钥前缀	访问级别	用例
`secret_`	完全读/写	创建内容、管理收藏、上传媒体、发布
`public_`	只读	仅通过传递API查询已发布的内容

对于MCP服务器的使用，您几乎总是希望密钥因为关键是要通过你的人工智能助手来管理内容。

本地开发

如果您在本地运行CMS：

"env": {
  "EELZAP_API_KEY": "secret_your_key",
  "EELZAP_BASE_URL": "http://localhost:5041",
  "EELZAP_PATH_PREFIX": "/api/public/v1"
}

可用工具

网站（1个工具）

工具	说明
`get_site`	获取与API密钥关联的当前网站

收藏（5个工具）

工具	说明
`list_collections`	列出网站中的所有收藏
`get_collection`	按ID获取收藏
`create_collection`	创建新收藏
`update_collection`	更新集合的名称或密钥
`delete_collection`	删除收藏及其所有项目

收集字段（5个工具）

工具	说明
`list_collection_fields`	列出集合中的所有字段
`create_collection_field`	向集合中添加新字段
`update_collection_field`	更新字段的配置
`delete_collection_field`	从集合中删除字段
`reorder_collection_fields`	更改字段的显示顺序

收集部分（4个工具）

工具	说明
`list_collection_sections`	列出集合中的所有部分
`create_collection_section`	创建新部分以对字段进行分组
`update_collection_section`	更新部分名称
`delete_collection_section`	删除一个部分

项目（7个工具+7个版本控制工具）

工具	说明
`list_items`	列出集合中的项目（带分页和搜索）
`get_item`	按ID获取单个项目
`create_item`	在集合中创建新项目
`update_item`	更新项目的字段值
`delete_item`	删除项目
`publish_item`	发布项目（通过交付API使其可用）
`unpublish_item`	取消发布项目

项目版本控制（7个工具）

工具	说明
`list_item_versions`	列出项目的版本历史记录
`get_item_version`	获取特定版本的详细信息
`create_item_draft`	从当前发布的版本创建草稿
`update_item_draft`	更新草稿字段值
`discard_item_draft`	丢弃当前草稿（非破坏性）
`publish_item_draft`	将草稿发布为实时版本
`rollback_item_version`	从历史版本创建草稿

文档（5个工具+7个版本控制工具）

工具	说明
`list_documents`	列出所有文档（如主页、关于页面等单例）
`get_document`	按ID获取文档
`create_document`	创建新文档
`update_document`	更新文档的名称或密钥
`delete_document`	删除文档

文档字段（5个工具）

工具	说明
`list_document_fields`	列出文档中的所有字段
`create_document_field`	在文档中添加新字段
`update_document_field`	更新字段的配置
`delete_document_field`	从文档中删除字段
`reorder_document_fields`	更改字段的显示顺序

文档部分（4个工具）

工具	说明
`list_document_sections`	列出文档中的所有部分
`create_document_section`	创建新部分以对字段进行分组
`update_document_section`	更新部分名称
`delete_document_section`	删除一个部分

文档值（2个工具）

工具	说明
`get_document_values`	获取文档的所有字段值
`set_document_values`	为文档设置字段值

文档发布（2个工具）

工具	说明
`publish_document`	发布文档
`unpublish_document`	取消发布文档

文档版本控制（7个工具）

工具	说明
`list_document_versions`	列出文档的版本历史记录
`get_document_version`	获取特定版本的详细信息
`create_document_draft`	从当前发布的版本创建草稿
`update_document_draft`	更新草稿字段值
`discard_document_draft`	丢弃当前草稿（非破坏性）
`publish_document_draft`	将草稿发布为实时版本
`rollback_document_version`	从历史版本创建草稿

媒体（7工具）

工具	说明
`list_media`	列出所有媒体资产
`get_media`	按ID获取媒体资产
`upload_media_from_url`	从URL上传媒体
`update_media`	更新媒体元数据（alt文本、标题）
`delete_media`	删除媒体资源
`publish_media`	发布媒体资源
`unpublish_media`	取消发布媒体资源

搜索引擎优化（4个工具）

工具	说明
`get_item_seo`	获取集合项的SEO元数据
`set_item_seo`	为集合项设置SEO元数据，包括Schema.org结构化数据
`get_document_seo`	获取文档的SEO元数据
`set_document_seo`	为文档设置SEO元数据，包括Schema.org结构化数据

交付API（5个工具）

工具	说明
`delivery_list_collections`	列出已发布的集合（公共API）
`delivery_get_collection`	获取已发布的集合（公共API）
`delivery_list_items`	列出集合中已发布的项（公共API）
`delivery_get_item`	获取已发布的项（公共API）
`delivery_get_document`	获取已发布的文档（公共API）

你能做什么？

连接后，尝试询问您的AI助手：

内容创作

创建包含标题、内容、作者和特色图像字段的博客集
“添加5篇关于web开发最佳实践的博客文章”
创建包含英雄标题、描述和团队部分的“关于”页面文档

内容管理

“列出我的所有集合及其字段架构”
“将我主页上的英雄头衔更新为‘用人工智能更快地构建’”
“发布博客收藏中的所有草稿项”

媒体

“从URL上传此图像，并将其设置为我最新博客文章的特色图像”
“列出所有媒体资产，并向我显示哪些未发布”

搜索引擎优化

“为所有博客帖子设置SEO元数据——根据内容生成元标题和描述”
“检查哪些项目缺少SEO元数据”

网站发现

显示我的网站结构——所有集合、文档及其字段
“我有哪些内容类型？列出所有内容。”

内容分发

“获取我发布的博客文章，并向我展示交付API返回的内容”
“检查主页文档是否已发布以及它提供了哪些数据”

故障排除

“需要EELZAP_API_KEY”

服务器找不到您的API密钥。确保它已设置在 env MCP配置的一部分（所有工具，包括Codex） [mcp_servers.eelzap.env]).

“连接被拒绝”或“ECONNREFUSED”

服务器无法访问API。检查：

你的 EELZAP_BASE_URL 正确（默认值： https://api.eelzap.com)
如果使用本地开发，请确保CMS应用程序在预期端口上运行

“401未经授权”

您的API密钥无效或已过期。从Eel Zap仪表板（设置>API键）生成一个新的，然后运行 eelzap-mcp switch-key.

“403禁止”

您正在使用公钥(public_)用于写入操作。切换到密钥(secret_).

服务器未出现在您的工具中

克劳德代码： 重新启动Claude Code或运行 /mcp 检查服务器状态
光标： 重新启动游标；检查“设置”>“工具和MCP”以了解服务器状态
VS代码： 检查MCP面板；尝试命令面板中的“MCP:列出服务器”
食品法典： 重新启动Codex；确保TOML配置位于 ~/.codex/config.toml
克劳德桌面： 完全退出并重新打开Claude Desktop（配置更改需要重新启动）

工具未加载/“无可用工具”

服务器已启动，但工具未注册。跑 eelzap-mcp doctor 以诊断或检查服务器日志在启动过程中是否有错误。

发展

git clone https://github.com/8ux-co/eelzap-mcp-server.git
cd eelzap-mcp-server
npm install
npm run build
npm test

在开发过程中本地运行：

EELZAP_API_KEY=secret_... npx tsx src/index.ts

MCP检验员测试：

EELZAP_API_KEY=secret_... npx @modelcontextprotocol/inspector npx tsx src/index.ts

使用说明

@8ux co/eelzap mcp服务器

快速开始

安装指南

克劳德代码

光标

VS代码

法典

克劳德桌面

CLI命令

配置

环境变量

API密钥类型

本地开发

可用工具

网站（1个工具）

收藏（5个工具）

收集字段（5个工具）

收集部分（4个工具）

项目（7个工具+7个版本控制工具）

项目版本控制（7个工具）

文档（5个工具+7个版本控制工具）

文档字段（5个工具）

文档部分（4个工具）

文档值（2个工具）

文档发布（2个工具）

文档版本控制（7个工具）

媒体（7工具）

搜索引擎优化（4个工具）

交付API（5个工具）

你能做什么？

内容创作

内容管理

媒体

搜索引擎优化

网站发现

内容分发

故障排除

“需要EELZAP_API_KEY”

“连接被拒绝”或“ECONNREFUSED”

“401未经授权”

“403禁止”

服务器未出现在您的工具中

工具未加载/“无可用工具”

发展

相关 MCP

网页搜索MCP服务器

Zotero文献库搜索与阅读MCP服务

Flomo笔记服务

Prometheus 指标查询 MCP 服务器

SSH远程命令执行MCP服务器

电话服务 MCP 服务器