> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
> Use this file to discover all available pages before exploring further.

# Rhombus API MCP Server

> Give Claude and other AI assistants direct access to your Rhombus cameras, doors, sensors, and alerts through the Model Context Protocol (MCP) Node.js server.

The **Rhombus API MCP Server** connects AI tools directly to your Rhombus security platform. Unlike the [Documentation MCP](/documentation-mcp) (which searches docs), this server gives AI assistants the ability to **take actions** — list cameras, pull clips, manage doors, review alerts, and more — using your Rhombus API key.

<Warning>
  This MCP server interacts with your live Rhombus environment. Actions taken through AI tools (unlocking doors, rebooting cameras, etc.) are real. Use with appropriate caution.
</Warning>

## What You Can Do

The server provides 30+ tools organized by capability:

<AccordionGroup>
  <Accordion title="Cameras & Video" icon="video">
    * **camera-tool** — List cameras, get camera details, view status and health
    * **clips-tool** — Search and retrieve saved video clips (manual and policy-triggered)
    * **video-walls-tool** — Manage video wall configurations for multi-camera monitoring
    * **reboot-cameras** — Remotely reboot cameras
    * **camera-uptime-tool** — Check camera uptime and connectivity history
  </Accordion>

  <Accordion title="Access Control & Doors" icon="door-open">
    * **access-control-tool** — Manage access control systems, credentials, and users
    * **door-tool** — Lock, unlock, and monitor door status
    * **door-schedule-exception-tool** — Create and manage door schedule overrides
    * **guest-management-tool** — Manage guest access and visitor credentials
  </Accordion>

  <Accordion title="Security & Monitoring" icon="shield-check">
    * **alarm-monitoring-tool** — Check monitoring status, manage threat cases
    * **policy-alerts-tool** — Review and dismiss policy-triggered alerts (motion, person detection, etc.)
    * **events-tool** — Query security events and activity logs
    * **rules-tool** — Manage automation rules and triggers
  </Accordion>

  <Accordion title="Analytics & Search" icon="chart-line">
    * **analytics-tool** — Space utilization, traffic patterns, and real-time scene analysis
    * **search-tool** — Search across cameras, events, and entities
    * **count-tool** — People counting and occupancy data
    * **faces-tool** — Face recognition person lookup
    * **lpr-tool** — License plate recognition searches
  </Accordion>

  <Accordion title="Organization & Users" icon="building">
    * **user-tool** — Manage users and permissions
    * **user-audit-tool** — Review user activity audit trails
    * **user-access-trail-tool** — Track user access history
    * **location-tool** — Manage locations and site configuration
    * **get-org-information** — Retrieve organization details
    * **report-tool** — Generate and retrieve reports
  </Accordion>

  <Accordion title="Utilities" icon="wrench">
    * **entity-lookup-tool** — Look up any entity by UUID
    * **get-entity-tool** — Get detailed entity information
    * **time-tool** — Current time utilities
    * **time-conversion-tool** — Convert between time formats and timezones
    * **update-tool** — Update entity properties
  </Accordion>
</AccordionGroup>

## Prerequisites

* A Rhombus organization with API access enabled
* An API key generated from the [Rhombus Console](https://console.rhombussystems.com/settings/api-management/)
* **Node.js 18+** (for npx) or **Docker** (for container-based setup)

## Setup

<Tabs>
  <Tab title="Claude Code">
    Add the Rhombus MCP server with a single command:

    ```bash theme={null}
    claude mcp add rhombus -- npx --yes --package rhombus-node-mcp mcp-server-rhombus
    ```

    Set your API key as an environment variable:

    ```bash theme={null}
    export RHOMBUS_API_KEY=YOUR_API_KEY
    ```

    Verify by asking Claude Code:

    ```text theme={null}
    "List all my Rhombus cameras"
    ```
  </Tab>

  <Tab title="Claude Desktop (npx)">
    Add to your `claude_desktop_config.json`:

    ```json theme={null}
    {
      "mcpServers": {
        "rhombus": {
          "command": "npx",
          "args": ["--yes", "--package", "rhombus-node-mcp", "mcp-server-rhombus"],
          "env": {
            "RHOMBUS_API_KEY": "YOUR_API_KEY"
          }
        }
      }
    }
    ```

    <Tip>
      On macOS, this file is located at `~/Library/Application Support/Claude/claude_desktop_config.json`
    </Tip>
  </Tab>

  <Tab title="Claude Desktop (Docker)">
    Run via Docker for an isolated environment:

    ```json theme={null}
    {
      "mcpServers": {
        "rhombus": {
          "command": "docker",
          "args": [
            "run", "-i", "--rm",
            "-e", "RHOMBUS_API_KEY=YOUR_API_KEY",
            "rhombussystems/mcp-server-rhombus"
          ],
          "env": {
            "RHOMBUS_API_KEY": "YOUR_API_KEY"
          }
        }
      }
    }
    ```
  </Tab>

  <Tab title="Cursor">
    Add to your Cursor MCP settings (`Cmd+Shift+P` → "Open MCP settings"):

    ```json theme={null}
    {
      "mcpServers": {
        "rhombus": {
          "command": "npx",
          "args": ["--yes", "--package", "rhombus-node-mcp", "mcp-server-rhombus"],
          "env": {
            "RHOMBUS_API_KEY": "YOUR_API_KEY"
          }
        }
      }
    }
    ```

    Restart Cursor after saving.
  </Tab>

  <Tab title="Smithery">
    Install automatically via [Smithery](https://smithery.ai/server/@RhombusSystems/rhombus-node-mcp):

    ```bash theme={null}
    npx -y @smithery/cli install @RhombusSystems/rhombus-node-mcp --client claude
    ```
  </Tab>
</Tabs>

## Example Workflows

### Monitor Your Cameras

Ask your AI assistant:

```text theme={null}
"Show me the status of all my cameras. Are any offline?"
```

The assistant uses the **camera-tool** to list cameras and check connectivity status.

### Review Security Alerts

```text theme={null}
"What policy alerts happened in the last 24 hours? Show me the most critical ones."
```

The assistant uses **policy-alerts-tool** to query recent alerts and **events-tool** for details.

### Manage Door Access

```text theme={null}
"Unlock the main entrance door for 30 seconds, then lock it again."
```

The assistant uses **door-tool** to control door locks in real time.

### Search for Vehicles

```text theme={null}
"Has a red Toyota been seen in any camera in the last week?"
```

The assistant uses **lpr-tool** to search license plate recognition data across your cameras.

### Generate a Report

```text theme={null}
"Give me a summary of foot traffic at the front entrance over the past month."
```

The assistant uses **analytics-tool** and **count-tool** for occupancy and traffic data.

## Running Locally

To build and run from source:

<Steps>
  <Step title="Clone the repository">
    ```bash theme={null}
    git clone https://github.com/RhombusSystems/rhombus-node-mcp.git
    cd rhombus-node-mcp
    ```
  </Step>

  <Step title="Install dependencies">
    ```bash theme={null}
    npm install
    ```
  </Step>

  <Step title="Build and run with Docker">
    ```bash theme={null}
    docker build -t mcp-server-rhombus .
    ```

    Then update your MCP config to use the local image name `mcp-server-rhombus` instead of `rhombussystems/mcp-server-rhombus`.
  </Step>
</Steps>

## Contributing

The MCP server is open source (MIT license). You can create new tools using the built-in scaffolding:

```bash theme={null}
npm run create:tool
```

This generates the boilerplate for a new tool in `src/tools/`.

## Resources

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/RhombusSystems/rhombus-node-mcp">
    Source code, issues, and contributions
  </Card>

  <Card title="npm Package" icon="npm" href="https://www.npmjs.com/package/rhombus-node-mcp">
    Package details and version history
  </Card>

  <Card title="Smithery" icon="hammer" href="https://smithery.ai/server/@RhombusSystems/rhombus-node-mcp">
    One-click installation for supported clients
  </Card>

  <Card title="Beta Feedback" icon="comment" href="https://rhmbs.link/beta_test">
    Share feedback and help shape development
  </Card>
</CardGroup>

<Note>
  The Rhombus API MCP Server is in beta. For questions or issues, reach out to [support@rhombus.com](mailto:support@rhombus.com) or visit [rhombus.community](https://rhombus.community).
</Note>