--- title: "FieldRobin developer resources" description: "FieldRobin API documentation, OpenAPI specification, MCP server, SDK, and agent integration resources." canonical_url: https://fieldrobin.com/developers markdown_url: https://fieldrobin.com/developers.md content_type: developer_resources product: "FieldRobin" company: "Doorkeeper Labs LLC" updated_at: 2026-10-01 language: en --- # FieldRobin developer resources FieldRobin developer resources include a versioned REST API, public OpenAPI documentation, an OAuth-protected Streamable HTTP MCP server, an official JavaScript/TypeScript SDK, and machine-readable AI discovery documents. ## REST API - [Public OpenAPI 3.1 document](https://fieldrobin.com/openapi.json) - Predictable aliases: [https://fieldrobin.com/api-docs](https://fieldrobin.com/api-docs) (developer portal), [https://fieldrobin.com/openapi](https://fieldrobin.com/openapi), [https://fieldrobin.com/openapi.yaml](https://fieldrobin.com/openapi.yaml) - [Signup and onboarding guide](https://fieldrobin.com/signup.md) - [Signup flow manifest](https://fieldrobin.com/.well-known/signup.json) - [API versioning and deprecation policy](https://fieldrobin.com/api-versioning.md) - Base URL: https://fieldrobin.com/api/v1 - Errors use a JSON envelope with code, message, resolution, and status fields. - Rate limits use RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, and RateLimit-Policy. A 429 response includes Retry-After. - Write-like agent handoffs accept an optional Idempotency-Key header (maximum 128 characters) so clients can retry safely. ## MCP - [MCP server card](https://fieldrobin.com/.well-known/mcp/server-card.json) - [MCP server card alias](https://fieldrobin.com/.well-known/mcp.json) - Streamable HTTP endpoint: https://fieldrobin.com/api/v1/mcp - Standard MCP endpoint alias: https://fieldrobin.com/.well-known/mcp - 45 authenticated read tools plus `create-customer` and `create-job` scope-authorized write tools. Read tools advertise `readOnlyHint: true`; write tools advertise `readOnlyHint: false`; all tools advertise `destructiveHint: false` and `openWorldHint: false`. - Authenticated `tools/list` includes write tools for read-only clients with per-tool required-scope metadata; a missing granular scope returns `MCP_WRITE_SCOPE_REQUIRED` and a protected-resource metadata URL so compatible clients can run OAuth step-up. - Catalog revision/hash metadata lets clients distinguish a code-only fix from a tool contract change. Refresh the catalog in a new session before asking the user to reconnect. - When direct writes are enabled, new OAuth registrations request `mcp:read mcp:customers:write mcp:jobs:write`; read-only deployments advertise `mcp:read` for new registrations. The consent page lets the user choose read-only, customer-write, job-write, or both. Existing read-only clients keep their current grant and must reconnect with explicit consent to add a write scope; existing clients may continue using legacy `mcp:use` for reads. - [Protected resource metadata](https://fieldrobin.com/.well-known/oauth-protected-resource) - [Authorization server metadata](https://fieldrobin.com/.well-known/oauth-authorization-server) - [OAuth and MCP authentication guide](https://fieldrobin.com/auth.md) - [Webhook integration guide](https://fieldrobin.com/webhooks.md) ### Quick starts - Claude custom connector: add the Streamable HTTP endpoint above and complete OAuth; existing Claude users can use the prefilled [FieldRobin connector link](https://claude.ai/customize/connectors?modal=add-custom-connector&connectorName=FieldRobin&connectorUrl=https%3A%2F%2Ffieldrobin.com%2Fapi%2Fv1%2Fmcp). - Claude Code: `claude mcp add --transport http fieldrobin https://fieldrobin.com/api/v1/mcp`, then authenticate from `/mcp`. - Gemini CLI: `gemini mcp add --scope user --transport http fieldrobin https://fieldrobin.com/api/v1/mcp`, then run `/mcp auth fieldrobin`. - ChatGPT and Codex: add the endpoint as a remote Streamable HTTP MCP server; OAuth discovery supplies the authorization and registration URLs. ## Agent discovery - [AI Catalog](https://fieldrobin.com/.well-known/ai-catalog.json) — ARD manifest of the public API, A2A agent, MCP server, and public discovery skill. - [ARD catalog](https://fieldrobin.com/.well-known/ard.json) - [did:web document](https://fieldrobin.com/.well-known/did.json) - [A2A Agent Card](https://fieldrobin.com/.well-known/agent-card.json) - [Agent Skills index](https://fieldrobin.com/.well-known/agent-skills/index.json) - Agent skills: `npx skills add praisondani/fieldrobin-skills` - Public skills repo: https://github.com/praisondani/fieldrobin-skills - [Public discovery skill](https://fieldrobin.com/agent-skills/fieldrobin-public-discovery/SKILL.md) - [MCP skill](https://fieldrobin.com/agent-skills/fieldrobin-mcp/SKILL.md) - [API skill](https://fieldrobin.com/agent-skills/fieldrobin-api/SKILL.md) - [OAuth skill](https://fieldrobin.com/agent-skills/fieldrobin-oauth/SKILL.md) - [FieldRobin MCP server](https://fieldrobin.com/mcp) - [FieldRobin SDK documentation](https://fieldrobin.com/sdk) - [FieldRobin auth docs](https://fieldrobin.com/auth) - [ChatGPT connector](https://fieldrobin.com/chatgpt) - [Scoped developer resources index](https://fieldrobin.com/developers/llms.txt) - [Scoped API resources index](https://fieldrobin.com/api/llms.txt) ## SDKs and CLI The official CLI is [@fieldrobin/cli](https://www.npmjs.com/package/@fieldrobin/cli) ([source](https://github.com/praisondani/fieldrobin-cli)). Terminal client for public API health, llms.txt discovery, OpenAPI, and product search. Does not access private workspace data. Install with `npm install --global @fieldrobin/cli` or run once with `npx --yes @fieldrobin/cli discover`. The official JavaScript/TypeScript SDK is [@fieldrobin/sdk](https://www.npmjs.com/package/@fieldrobin/sdk) ([source](https://github.com/praisondani/fieldrobin-sdk)). Typed JavaScript/TypeScript client for public discovery, OpenAPI, A2A, and UCP checkout (fetch-based, zero runtime deps). Maintained as a public package mirror of packages/fieldrobin-sdk. ## Other discovery documents - [Agent index](https://fieldrobin.com/llms.txt) - [Full agent index](https://fieldrobin.com/llms-full.txt) - [Developer resources Markdown alias](https://fieldrobin.com/developers.md) - [Pricing Markdown alias](https://fieldrobin.com/pricing.md) - [Homepage Markdown alias](https://fieldrobin.com/index.md) - [API catalog](https://fieldrobin.com/.well-known/api-catalog) - [OAuth guide](https://fieldrobin.com/auth.md) - [Webhook guide](https://fieldrobin.com/webhooks.md) - [Public documentation](https://docs.fieldrobin.com/) Authenticated workspace routes and customer data are not public discovery resources.