The MineOS API Model Context Protocol (MCP) server enables AI-powered tools and code editors like Cursor, Gemini, Claude, ChatGPT and more to interact directly with your MineOS account.

What is MCP?

Model Context Protocol (MCP) is an open standard that allows AI applications to securely access external data sources and tools. The MineOS MCP server provides AI agents with:

Direct API access to MineOS API functionality. Every endpoint that is included in the docs is included in the MCP server.
Documentation search capabilities, to help you learn how the MineOS works. This is very useful for coding agents to help them figure out what each endpoint does.

MineOS MCP Server Setup

MineOS hosts a remote MCP server at https://developers.mineos.ai/mcp. Configure your AI development tools to connect to this server. MineOS API requires an API key, you can configure your MCP client to pass the Authentication header, or just tell your agent the API key and it will use it.

Add to~/.cursor/mcp.json:

{
"mcpServers": {
    "MineOS": {
      "type":"stdio",
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote@latest",
        "https://developers.mineos.ai/mcp",
        "--header",
        "Authorization: Bearer <MINEOS_API_KEY>"
      ]
    }
}
}

Testing Your MCP Setup

Once configured, you can test your MCP server connection:

Open your AI editor (Cursor, Windsurf, etc.)
Start a new chat with the AI assistant
Ask about MineOS API - try questions like:
- "How do I [common use case]?"
- "Show me an example of [API functionality]"
- "List all systems from my inventory"
- "Create a new DSR"

On the first chat, or as a base prompt, you should tell the agent the correct tenant for your account (EU or US), otherwise you will get authentication/connection issues.

The AI should now have access to your MineOS account data and documentation through the MCP server.