Tool gateway

Add a tool server

Registers an MCP server the gateway will forward tool calls to. Its tools arrive switched off until approved — refresh it next. Up to 20 per organisation. Owner or admin, or a key with mcp:write.

post/client/mcp/upstreams

Request

  • Base URL: https://api.roar-ai.com
  • URL: https://api.roar-ai.com/client/mcp/upstreams
  • Auth: HTTP bearer

Request body

namestring required

Lower-case letters, digits and single hyphens, 1–20 characters. Unique in your organisation

urlstring uri required

The server’s Streamable HTTP endpoint. https only, no username or password in it

argsPolicy'pass' | 'redact' | 'block'

Response

The added tool server

idstring uuid required
clientIdstring uuid required
namestring required

The prefix agents see on its tools: <name>__<tool>

urlstring uri nullable required

Null unless the caller may change tool servers: an owner or admin session, or an org-level key with mcp:write. An address can carry a token in its path.

authType'none' | 'bearer' | 'header' | 'oauth' required

oauth: an owner or admin SIGNS IN to it; its state is GET /client/mcp/upstreams/{id}/oauth

authHeaderstring nullable required

The header NAME for header auth — never its value. Null on the same terms as url

status'active' | 'disabled' required
argsPolicy'pass' | 'redact' | 'block' required

What happens to personal data in a call’s ARGUMENTS. Results are always masked

toolsFetchedAtstring date-time nullable required

Null until the first successful refresh

lastErrorstring nullable required

Why the last refresh failed, in words safe to show. Null after a success

createdAtstring date-time required
updatedAtstring date-time required
hasCredentialboolean required

Whether a credential is stored. The credential itself is never returned

Changes

No recorded changes to this operation across all 1 revision of this API.