@openserp/mcp

@openserp/mcp

Model Context Protocol server for OpenSERP OSS and OpenSERP Cloud.

When OPENSERP_API_KEY is not set, the server uses OSS mode at http://localhost:7000 and writes:

[openserp-mcp] No OPENSERP_API_KEY set - using OSS mode at http://localhost:7000.
[openserp-mcp] Get an API key: https://openserp.org/dashboard/status
[openserp-mcp] Docs: https://openserp.org/docs | Issues: https://github.com/karust/openserp/issues

Set OPENSERP_API_KEY to use OpenSERP Cloud. API keys are available at https://openserp.org/dashboard/status. Set OPENSERP_BASE_URL to target another compatible OpenSERP API base URL.

Tools

• search
• mega_search
• fast_search
• any_search
• image_search
• mega_image
• get_usage
• list_engines
• extract

Claude Desktop

Local OSS mode:

{
  "mcpServers": {
    "openserp": {
      "command": "npx",
      "args": ["-y", "@openserp/mcp"]
    }
  }
}

Cloud mode:

{
  "mcpServers": {
    "openserp": {
      "command": "npx",
      "args": ["-y", "@openserp/mcp"],
      "env": {
        "OPENSERP_API_KEY": "osk_live_..."
      }
    }
  }
}

Cursor

For stdio use, add an MCP server entry:

{
  "mcpServers": {
    "openserp": {
      "command": "npx",
      "args": ["-y", "@openserp/mcp"],
      "env": {
        "OPENSERP_API_KEY": "osk_live_..."
      }
    }
  }
}

For remote-style HTTP use, run:

npx -y @openserp/mcp --http --host 127.0.0.1 --port 3333

Then point a streamable HTTP MCP client to:

http://127.0.0.1:3333/mcp

Clients that still use the older SSE transport can connect to:

http://127.0.0.1:3333/sse

Development

corepack pnpm install
corepack pnpm --filter @openserp/mcp build
corepack pnpm --filter @openserp/mcp typecheck
corepack pnpm --filter @openserp/mcp dev:stdio
corepack pnpm --filter @openserp/mcp dev:http

Environment

• OPENSERP_API_KEY: Cloud API key from https://openserp.org/dashboard/status.
• OPENSERP_BASE_URL: API base URL override.
• OPENSERP_BACKEND: Optional backend hint, oss or cloud.
• OPENSERP_TIMEOUT_MS: SDK request timeout in milliseconds.
• HOST: HTTP host, default 127.0.0.1.
• PORT: HTTP port, default 3333.