使用说明
内容堆栈MCP服务器
该模型上下文协议(MCP)服务器与Contentstack的内容管理API集成,使Claude等人工智能助手能够通过标准化协议与您的Contentstack CMS进行交互。
注: 这是Contentstack MCP服务器的早期版本。请参阅 路线图 了解即将到来的改进和计划中的功能。
目录
特性
可用资源
content-types:列出所有内容类型(URI:contentstack://content-types)content-type:按UID获取内容类型(URI:contentstack://content-type/{uid})entries:按内容类型获取条目(URI:contentstack://entries/{content_type_uid})entry:获取特定条目(URI:contentstack://entry/{content_type_uid}/{entry_uid})assets:列出所有资产(URI:contentstack://assets)
内容类型管理
- 创建、更新和删除内容类型
- 定义模式、选项、字段规则和分类法
- 管理全局字段
出入管理
- 创建、更新和删除条目
- 跨环境发布和取消发布条目
- 具有过滤、分页和排序选项的查询条目
全球现场管理
- 创建和更新全局字段,以便跨内容类型重用
- 使用分页选项检索全局字段
内容工作流
- 引导式内容创建工作流程
- 内容分析和见解
- 移民规划援助
安装
先决条件
- Node.js(v16.0.0或更高版本)
- Contentstack帐户
- API证书(API密钥和管理令牌)
NPM安装
使用此MCP服务器的最简单方法是通过NPM:
# Install globally
npm install -g @drossman/contentstack-mcp
# Or use directly via npx
npx @drossman/contentstack-mcp
手动安装
-
克隆存储库:
git clone https://github.com/darekrossman/contentstack-mcp.git cd contentstack-mcp -
安装依赖项:
npm install -
设置环境变量:
cp .env.example .env编辑
.env包含您的Contentstack凭据的文件:CONTENTSTACK_API_KEY=your_api_key_here CONTENTSTACK_MANAGEMENT_TOKEN=your_management_token_here # Optional: Specify branch if using branches CONTENTSTACK_BRANCH=your_branch_name -
构建并启动服务器:
npm run build npm start
通过Smithery CLI安装
您还可以使用安装此MCP服务器 Smithery CLI:
npx @smithery/cli install contentstack-mcp --client claude
请参阅 Smithery CLI文档 了解更多详细信息和高级用法。
发展
开发设置
对于开发,您可以使用:
npm run dev
这将使用以下命令启动服务器 ts-node 以实现更快的开发周期。
代码质量
此项目使用 Biome.js 用于裁剪和格式化。它提供了一致的代码风格,并有助于及早发现潜在问题。
可用命令
-
Lint代码:
npm run lint -
棉绒和修复:
npm run lint:fix -
格式码:
npm run format -
格式化和修复:
npm run format:fix
配置
认证
此服务器需要使用Contentstack的API进行身份验证:
管理令牌(必填):
- 具有预定义权限的堆栈级令牌
- 通过设置
CONTENTSTACK_MANAGEMENT_TOKEN环境变量 - 从Contentstack仪表板生成:设置>令牌>管理令牌
API密钥(必需):
- 用于身份验证的堆栈API密钥
- 通过设置
CONTENTSTACK_API_KEY环境变量
分支机构支持
如果您的Contentstack帐户使用分支,您可以指定一个分支:
CONTENTSTACK_BRANCH=develop
与AI助手集成
Claude桌面版
要将此服务器与Claude for Desktop一起使用,请执行以下操作:
-
编辑您的Claude for Desktop配置文件:
- 雨衣:
~/Library/Application Support/Claude/claude_desktop_config.json - 窗户:
%APPDATA%\Claude\claude_desktop_config.json
- 雨衣:
-
将此服务器添加到
mcpServers章节:{ "mcpServers": { "contentstack": { "command": "npx", "args": ["-y", "@drossman/contentstack-mcp"], "env": { "CONTENTSTACK_API_KEY": "your_api_key_here", "CONTENTSTACK_MANAGEMENT_TOKEN": "your_management_token_here" } } } } -
重新启动桌面版的Claude
光标
要将此服务器与Cursor一起使用,请添加Contentstack MCP服务器配置:
{
"mcpServers": {
"contentstack": {
"command": "npx",
"args": ["-y", "@drossman/contentstack-mcp"],
"env": {
"CONTENTSTACK_API_KEY": "your_api_key_here",
"CONTENTSTACK_MANAGEMENT_TOKEN": "your_management_token_here",
}
}
}
}
使用Smithery进行安装
您还可以使用安装此MCP服务器 Smithery CLI 使用您选择的客户端:
npx -y @smithery/cli install @drossman/contentstack-mcp --client claude
可用客户包括:
- 克劳德
- 克莱恩
- 帆板运动
- 道路代码
- 幽默
- enconvo
- 光标
- vscode
- vscode内部人士
- 博泰
- 亚马逊基岩
- 亚马逊
请参阅 Smithery CLI文档 了解更多详细信息和高级用法。
路线图
- [ ] 增强AI上下文理解:改进复杂查询的上下文配置
- [ ] 高级查询和筛选:支持按多个条件和自定义字段进行筛选
- [ ] 工作流和发布自动化:启用人工智能驱动的内容工作流操作
- [ ] 资产管理增强功能:添加直接资产操纵功能
- [ ] 批量操作支持:对条目和资产执行批处理操作
- [ ] 改进的错误处理和AI反馈:优化AI消费的错误消息
- [ ] 用户特定的上下文和权限:根据用户权限定制操作
- [ ] 自定义工具的可扩展性:创建扩展框架
- [ ] 实时事件处理:为反应式AI行为添加webhook支持
- [ ] 综合文档:制定人工智能交互的详细指南
Shoutout
特别感谢 伊沃·托比这个项目及其作者深受他在这个领域的工作的启发。
许可证
麻省理工学院
免责声明: 此项目不隶属于Contentstack,也不受其认可或支持。这是一个独立的开源项目,旨在与Contentstack API合作。
