Response shape
Every tool returns MCP text content with a single pretty-printed JSON document:
{
"ok": true,
"status": 200,
"body": {}
}ok—truefor HTTP 2xx,falseotherwise.status— the upstream HTTP status code.body— parsed JSON when the API returned JSON, otherwise the raw text.
On HTTP failure ok is false, the MCP result is also marked isError, and the same shape is preserved so the assistant can reason about the error.
Health and account
| MCP tool | HTTP | Notes |
|---|---|---|
odetect_health_check | GET /health-check | No x-api-key. Use to verify connectivity. |
odetect_get_info | GET /info | Subscription, limits, usage counters, driver path. |
Profiles
| MCP tool | HTTP | Inputs |
|---|---|---|
odetect_get_profiles | GET /profile | — |
odetect_get_profile | GET /profile/:id | id (UUID) |
odetect_delete_profile | DELETE /profile/:id | id (UUID) |
odetect_post_profile_create | POST /profile/:os/create | os path segment (e.g. windows, linux), optional name, optional authPassword |
odetect_post_profile_start | POST /profile/:id/start | id; optional geolocationMode — one of allow, block, user; optional authPassword |
odetect_post_profile_stop | POST /profile/:id/stop | id |
odetect_post_profile_cookies | POST /profile/:id/cookies | id; optional authPassword. For full cookie import payloads, confirm against your local swagger.json. |
odetect_post_profile_set_tags | POST /profile/set/tags | profileId, tagIds (string array). Assign / replace tag list |
odetect_post_profile_set_proxy | POST /profile/set/proxy | profileId, proxyId |
Proxies
| MCP tool | HTTP | Inputs |
|---|---|---|
odetect_get_proxies | GET /proxy | — |
odetect_get_proxy | GET /proxy/:id | id (UUID) |
odetect_post_proxy | POST /proxy | email, password (fields expected by the local API) |
odetect_delete_proxy | DELETE /proxy/:id | id (UUID) |
odetect_post_proxy_verify | POST /proxy/:id/verify | id. Checks connectivity / validity for the saved proxy. |
Tags
| MCP tool | HTTP | Inputs |
|---|---|---|
odetect_get_tags | GET /tag | — |
odetect_get_tag | GET /tag/:id | id (UUID) |
odetect_post_tag | POST /tag | Optional title, color, user, team |
odetect_patch_tag | PATCH /tag/:id | id; optional title, color |
odetect_delete_tag | DELETE /tag/:id | id (UUID) |
Server instructions
The MCP server also publishes an instructions string as metadata, summarizing its capabilities for the host. See start0detectMcpServer in src/index.ts for the exact text.