onyx MCP

This is the official onyx Model Context Protocol (or "MCP" for short) server.

Prerequisites

• Node.js version as specified in .node-version file

Getting started

Install the CLI globally:

# npm
npm install -g @sit-onyx/modelcontextprotocol

# pnpm
pnpm install -g @sit-onyx/modelcontextprotocol

Now you can run the onyx-mcp command:

onyx-mcp -h

Using with the Gemini CLI

Add this entry to your Gemini settings (in ~/.gemini/settings.json):

{
  "$schema": "https://raw.githubusercontent.com/google-gemini/gemini-cli/main/schemas/settings.schema.json",
  "mcp": {
    "allowed": ["onyx-mcp"]
  },
  "mcpServers": {
    "onyx-mcp": {
      "description": "Information about components of the onyx UI component library",
      "command": "onyx-mcp",
      "args": ["-r"]
    }
  }
}

Save the file and confirm that the MCP has been set up correctly:

gemini mcp list

Development

Run this command in the monorepo root:

pnpm run dev modelcontextprotocol

This starts the "build" watcher and the @modelcontextprotocol/inspector locally.

You must reload the inspector browser website after changes to the @sit-onyx/modelcontextprotocol source code. Using the "Reconnect" button does not suffice!