Getting Started
Welcome to the Cosmic MCP Server! This guide will help you get up and running quickly.
Prerequisites
Before you begin, ensure you have:
- Node.js 18+ installed
- A Cosmic.js account and bucket
- Your Cosmic API credentials
Installation
Via NPX (Recommended)
The easiest way to get started is using npx:
bash
npx -y cosmic-mcp
Via NPM
You can also install the package globally:
bash
npm install -g cosmic-mcp
cosmic-mcp
Configuration
Create a .env
file in your project directory with your Cosmic credentials:
bash
COSMIC_BUCKET_SLUG=your-bucket-slug
COSMIC_READ_KEY=your-read-key
COSMIC_WRITE_KEY=your-write-key
First Steps
- Test the connection: Run the server and verify it connects to your Cosmic bucket
- Explore the tools: Use the MCP client to see available tools
- Try some examples: Check out the AI Assistant Prompts for inspiration
Next Steps
Need Help?
- Check the Tools Reference for detailed API documentation
- Review the AI Prompts for usage examples
- Visit the GitHub repository for issues and discussions