---
title: "The tool gateway as you see it"
method: GET
path: "/client/mcp/overview"
tags: ["Tool gateway"]
---

# The tool gateway as you see it

`GET /client/mcp/overview`

## Request

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

Where agents connect, whether the gateway is on for your organisation, what you may change, and which keys you can see would be served tools right now (tool names only). Requires `mcp:read`.

## Response `200`

Overview

- McpOverview
  - `gatewayUrl` string, uri, required: Where an agent connects over MCP, sending `Authorization: Bearer <key>`
  - `enabled` boolean, required: False when Roar has turned the gateway off for your organisation
  - `disabledAt` string, date-time, nullable, required
  - `canManage` boolean, required: Whether this caller may change servers, tools, bundles, every grant and project switches
  - `grantProjectIds` string[], required: Projects this caller may give bundles to and take them from
  - `maxUpstreams` integer, required: The most tool servers your organisation may register
  - `keys` object[], required: Keys this caller can see that would be served at least one tool now
    - `id` string, uuid, required
    - `name` string, nullable, required
    - `prefix` string, required
    - `projectId` string, uuid, nullable, required
    - `tools` string[], required: Tool names as the agent sees them
  - `setup` McpSetupState, required: How far setup has got, each step read from what exists now. The two steps about keys count only the projects you belong to
    - `serverAdded` boolean, required: A tool server is registered and ready — it needs no sign-in, or it is signed in
    - `toolsRead` boolean, required: A server’s tool list has been read
    - `toolsApproved` boolean, required: A tool is approved at its current definition, listed and switched on
    - `bundleMade` boolean, required: A bundle holds a tool
    - `accessGiven` boolean, required: A key you can see would be served a tool now
    - `agentConnected` boolean, required: An agent has used a tool, with a key you can see, in the last 30 days
    - `signInNeeded` object, nullable, required: The oldest tool server that signs in and is not signed in; null when there is none
      - `name` string, required
      - `again` boolean, required: Its sign-in stopped working, rather than never having happened

## Other responses

- `403`: Key lacks mcp:read

---

[API](https://skmtc.dev/roar-ai/apis/roar-ai-api.md) · [All operations](https://skmtc.dev/roar-ai/apis/roar-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/roar-ai/apis/roar-ai-api/revisions/37e4d0d5a7fe?raw)