spaceship

Spaceship MCP server provides a natural language interface to the Spaceship API via the Model Context Protocol. It lets MCP-enabled AI clients issue requests to manage Spaceship domains, DNS records, contacts, and marketplace listings, among other resources, using plain language. The server exposes standard MCP endpoints through a compatible client, so you can drive Spaceship tasks from agents like Claude Code, Codex, Gemini, VS Code-based workflows, or Cursor/Copilot integrations. To get started, configure the server with your Spaceship API credentials and connect via an MCP client that supports stdio-based command servers. Examples in the repository show common integration patterns for editor plugins and CLI tools, all routing through the same npx spaceship-mcp runtime.

Once running, you can leverage the server’s capabilities to create, read, update, and delete Spaceship resources, perform searches, and trigger marketplace actions using natural language prompts. The toolset is designed to be portable across clients, so you can mix and match clients (e.g., Claude Code, Codex CLI, Gemini CLI) while keeping the same underlying MCP server configuration.

Prerequisites:\n- Node.js 20 or newer installed on your machine (per project README).\n- npm (comes with Node.js).\n- Optional: Spaceship API credentials (SPACESHIP_API_KEY and SPACESHIP_API_SECRET).\n\nStep-by-step:\n1) Install Node.js v20+ from the official site.\n2) Ensure npm is available: npm -v.\n3) Obtain Spaceship API credentials and export them or provide them via the MCP config (see environment example below).\n4) Run the MCP server using npx (no global install required):\n\nbash\n# Quick run using npx (no prior install needed)\nnpx -y spaceship-mcp\n\n\n5) Alternatively, run via Docker (see Docker snippet in repository):\n\nbash\ndocker run -i --rm \ -e SPACESHIP_API_KEY=your-key \ -e SPACESHIP_API_SECRET=your-secret \ ghcr.io/bartwaardenburg/spaceship-mcp\n\n\n6) If you prefer a persistent setup, create an MCP config in your editor or project (see example blocks in the README) with the following structure:\n\njson\n{ "mcpServers": { "spaceship-mcp": { "command": "npx", "args": ["-y", "spaceship-mcp"], "env": { "SPACESHIP_API_KEY": "your-key", "SPACESHIP_API_SECRET": "your-secret" } } } }\n\n\nPrerequisite notes: The exact command/args can vary if you pin a specific MCP runtime; the canonical approach shown uses npx with the package name as in the README. Ensure your environment variables are kept secure and not committed to version control.

Tips and notes:\n- Required env vars: SPACESHIP_API_KEY and SPACESHIP_API_SECRET. Optional env vars include SPACESHIP_CACHE_TTL, SPACESHIP_MAX_RETRIES, SPACESHIP_TOOLSETS, and SPACESHIP_DYNAMIC_TOOLS depending on configuration needs.\n- The MCP server uses a stdio transport for communication with clients; configure your client (VS Code, Cursor, Windsurf, etc.) accordingly using command: npx -y spaceship-mcp.\n- If you encounter authentication or rate-limit issues, verify that the API credentials are correct and that your environment allows outbound HTTP requests to Spaceship API.\n- For Docker deployments, you can set credentials via environment variables at runtime as shown in the Docker example.\n- The npm package name is spaceship-mcp; using npx ensures you don’t need a global install for quick start.\n- This server is community-maintained and not officially affiliated with Spaceship; rotate credentials and audit usage as needed.