npm package: @realman_robot/mcp-server
Description: RealMan robotic arm API documentation MCP Server for Cursor/Claude Code | 睿尔曼机械臂API文档MCP Server
Latest version: 1.1.0

# @realman/mcp-server

MCP Server for [RealMan](https://www.realman-robotics.cn/) collaborative robot arm development — gives AI coding assistants direct access to 300+ API methods, 85 error codes, runnable examples, and deployment guides.

## Supported Platforms

| Platform | macOS | Windows | Linux |
|----------|-------|---------|-------|
| **Cursor** | ✅ | ✅ | ✅ |
| **Claude Code** | ✅ | ✅ | ✅ |
| **Claude Desktop** | ✅ | ✅ | — |
| **OpenAI Codex** | ✅ | ✅ | ✅ |
| **Windsurf** | ✅ | ✅ | ✅ |

Requires **Node.js >= 18**. All data is bundled — no network required at runtime.

## Install

```bash
npx @realman/mcp-server
```

## Configuration

### Cursor

`.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "realman": {
      "command": "npx",
      "args": ["-y", "@realman/mcp-server"]
    }
  }
}
```

### Claude Code

```bash
claude mcp add realman -- npx -y @realman/mcp-server
```

Or `.mcp.json`:

```json
{
  "mcpServers": {
    "realman": {
      "command": "npx",
      "args": ["-y", "@realman/mcp-server"]
    }
  }
}
```

### Claude Desktop

`~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
`%APPDATA%\Claude\claude_desktop_config.json` (Windows):

```json
{
  "mcpServers": {
    "realman": {
      "command": "npx",
      "args": ["-y", "@realman/mcp-server"]
    }
  }
}
```

### OpenAI Codex

```bash
codex mcp add realman -- npx -y @realman/mcp-server
```

Or `~/.codex/config.toml`:

```toml
[mcp_servers.realman]
command = "npx"
args = ["-y", "@realman/mcp-server"]
```

### Windsurf

```json
{
  "mcpServers": {
    "realman": {
      "command": "npx",
      "args": ["-y", "@realman/mcp-server"]
    }
  }
}
```

## Tools

| Tool | Description | Example query |
|------|-------------|---------------|
| `get_started` | First-time connection guide with default IP/port, Python code, cable checks, power-on sequence | "How to connect RM75B", "ping fails" |
| `find_capability` | Search 300+ API methods across Python/C/JSON. Returns signature, params, return values, example code | "force control", "rm_movej", "gripper" |
| `get_runnable_example` | Copy-paste-ready Python examples with safety warnings and model compatibility notes | "joint motion example", "force grasp" |
| `diagnose_issue` | Error code lookup with severity, root cause, fix, and recovery code | "0x1002", "joint communication error" |
| `get_robot_spec` | Product specs by model (RM65/RM75/ECO62/ECO63/ECO65/GEN72/RML63). Filterable by parameter | "RM75B payload", "ECO65 reach" |
| `deployment_guardrails` | Pre-deployment safety checklists, collision recovery, Modbus/ROS integration | "collision recovery", "emergency stop" |

## Data Coverage

| Category | Count |
|----------|-------|
| C API | 30 classes, 300 methods |
| Python API | 30 classes, 298 methods |
| JSON protocol | 18 topics, 249 commands |
| Structs | 124 (C + Python) |
| Error codes | 85 with severity levels |
| Documentation | 632 pages |
| Runnable examples | 7 verified Python scripts |

## Supported Robot Models

RM65 · RM75 · RML63 · ECO62 · ECO63 · ECO65 · GEN72 · RX75

## Example Conversations

Once configured, ask your AI assistant:

- "I just got an RM75B, how do I connect?"
- "What parameters does rm_movej take?"
- "Give me a Python script for joint motion"
- "Error 0x1002 — what does it mean?"
- "What's the payload of RM65 vs ECO65?"
- "What safety checks before deploying to production?"

Every response includes: **conclusion → applicable conditions → runnable code → verification method → fallback steps**.

## Development

```bash
cd mcp-server
npm install
npm run dev
```

## License

MIT