Cosmic MCP Server

Cosmic MCP服务器

     ](https://www.npmjs.com/package/cosmic-mcp) ](https://www.npmjs.com/package/cosmic-mcp)

坚固耐用，可随时投入生产 模型上下文协议（MCP） 用于与交互的服务器 宇宙的 无头CMS。此服务器提供了一套全面的工具，用于创建、读取、更新和删除Cosmic存储桶中的对象、类型和媒体。

✨ 特性

• 综合工具集： Cosmic对象、对象类型和介质的完整CRUD操作。
• 稳健的架构： 采用干净的三层架构（服务器、服务、存储库）构建。
• 强烈类型： 用TypeScript编写，对所有输入使用Zod进行严格验证。
• 生产就绪： 包括集中式日志记录、速率限制和优雅的错误处理。
• 易于配置： 使用简单的设置 .env 申请您的宇宙证书。
• 可扩展： 旨在通过新的工具和服务轻松扩展。

______________________________________________________________________

🚀 入门指南

先决条件

• 包子 （v1.0或更高版本）
• A. 宇宙的 账户和桶。

1.安装

克隆存储库并安装依赖项：

git clone https://github.com/patgpt/cosmic-mcp.git
cd cosmic-mcp
bun install

2.配置

复制示例环境文件并填写您的Cosmic bucket凭据。你可以在你的宇宙仪表板上找到这些 _桶>设置>API键_.

cp .env.example .env

你的 .env 文件应该看起来像这样：

# .env
COSMIC_BUCKET_SLUG="your-bucket-slug"
COSMIC_READ_KEY="your-read-key"
COSMIC_WRITE_KEY="your-write-key"
DEBUG="false" # Set to "true" for verbose logging

3.运行服务器

使用以下命令启动MCP服务器：

bun start

服务器将连接并准备好接收来自任何兼容MCP的客户端的请求。

4.与MCP客户端一起使用

对于VS代码（使用Claude Dev扩展）

将此配置添加到您的VS代码设置或Claude Dev配置中：

{
  "mcp": {
    "servers": {
      "Cosmic": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "cosmic-mcp"],
        "env": {
          "COSMIC_BUCKET_SLUG": "your-bucket-slug",
          "COSMIC_READ_KEY": "your-read-key",
          "COSMIC_WRITE_KEY": "your-write-key",
          "DEBUG": "false"
        }
      }
    }
  }
}

对于光标

将此配置添加到您的 .cursor/mcp.json 文件：

{
  "mcpServers": {
    "Cosmic": {
      "command": "npx",
      "args": ["-y", "cosmic-mcp"],
      "env": {
        "COSMIC_BUCKET_SLUG": "your-bucket-slug",
        "COSMIC_READ_KEY": "your-read-key",
        "COSMIC_WRITE_KEY": "your-write-key",
        "DEBUG": "false"
      }
    }
  }
}

备选方案：地方发展

如果您正在本地开发或更喜欢使用本地版本：

对于VS代码：

{
  "mcp": {
    "servers": {
      "Cosmic": {
        "type": "stdio",
        "command": "node",
        "args": ["path/to/cosmic-mcp/dist/server.js"],
        "env": {
          "COSMIC_BUCKET_SLUG": "your-bucket-slug",
          "COSMIC_READ_KEY": "your-read-key",
          "COSMIC_WRITE_KEY": "your-write-key",
          "DEBUG": "true"
        }
      }
    }
  }
}

对于光标：

{
  "mcpServers": {
    "Cosmic": {
      "command": "node",
      "args": ["path/to/cosmic-mcp/dist/server.js"],
      "env": {
        "COSMIC_BUCKET_SLUG": "your-bucket-slug",
        "COSMIC_READ_KEY": "your-read-key",
        "COSMIC_WRITE_KEY": "your-write-key",
        "DEBUG": "true"
      }
    }
  }
}

注： 替换 your-bucket-slug, your-read-key，以及 your-write-key 使用您实际的宇宙桶凭证。你可以在你的宇宙仪表板上找到这些 _桶>设置>API键_.

______________________________________________________________________

🛠️ 可用工具

此MCP服务器公开了以下工具。所有工具都设计为由AI代理或其他MCP客户端调用。

有关每个工具的详细输入模式，请参阅 📚 文档 或 src/manifest.ts 文件。

______________________________________________________________________

📚 文档

综合文档可在以下网址获得 ****

文件包括：

• 入门指南 -完整的设置和安装说明
• 配置参考 -所有配置选项和环境变量
• 工具API文档 -所有可用工具的详细参考
• AI助手提示 -有效AI交互的示例提示
• MCP客户端设置 -VS代码、游标和其他MCP客户端的配置

当地文件

您还可以在本地运行文档：

# Install dependencies
npm install

# Start the documentation server
npm run docs:dev

# Build the documentation
npm run docs:build

______________________________________________________________________

🧪 运行测试

该项目通过测试来确保可靠性。

# Run all tests
bun test

______________________________________________________________________

🤝 贡献

欢迎投稿！如果您有建议或发现错误，请打开一个问题进行讨论。

请查看我们的 贡献.md 有关如何为该项目做出贡献的详细指南，包括：

• 开发设置和工作流程
• 代码样式和标准
• 测试要求
• 拉取请求流程
• 释放过程

📄 许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。