MCP Agents API
Reference for the MCP Agents endpoint group — 7 endpoints.
Generated from the live OpenAPI spec. Re-run _generate_api_reference.py after backend changes.
Authentication#
All endpoints require a Bearer JWT in the Authorization header unless noted otherwise. See Concepts → Tokens and scopes and Reference → OAuth endpoints for how to obtain one.
Endpoints#
GET /api/v1/admin/agents/#
List Agents
List MCP agents with filtering.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page |
query | no | integer |
|
per_page |
query | no | integer |
|
tenant_id |
query | no | string | null |
|
status |
query | no | string | null |
|
agent_type |
query | no | string | null |
|
search |
query | no | string | null |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
POST /api/v1/admin/agents/#
Create Agent
Create a new MCP agent. Returns client credentials (secret shown only once).
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
authorization |
header | no | string | null |
Request body:
Required.
application/json→ object
Responses:
| Status | Body |
|---|---|
201 |
application/json → any |
422 |
application/json → HTTPValidationError |
DELETE /api/v1/admin/agents/{agent_id}#
Delete Agent
Soft delete an MCP agent.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
agent_id |
path | yes | string |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
204 |
Successful Response |
422 |
application/json → HTTPValidationError |
GET /api/v1/admin/agents/{agent_id}#
Get Agent
Get an MCP agent by ID.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
agent_id |
path | yes | string |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
PATCH /api/v1/admin/agents/{agent_id}#
Update Agent
Update an MCP agent.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
agent_id |
path | yes | string |
|
authorization |
header | no | string | null |
Request body:
Required.
application/json→ object
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
GET /api/v1/admin/agents/{agent_id}/activity#
Get Agent Activity
Get activity logs for an agent.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
agent_id |
path | yes | string |
|
page |
query | no | integer |
|
per_page |
query | no | integer |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
POST /api/v1/admin/agents/{agent_id}/rotate-secret#
Rotate Agent Secret
Rotate the client secret for an agent. Returns new secret (shown only once).
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
agent_id |
path | yes | string |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
Schemas#
Definitions for every type referenced by the endpoints above. Schema-to-schema references on this page link within the page; cross-page references would require visiting the linked page.
HTTPValidationError#
| Field | Type | Required | Description |
|---|---|---|---|
detail |
array of ValidationError |
no |
ValidationError#
| Field | Type | Required | Description |
|---|---|---|---|
loc |
array of string | integer |
yes | |
msg |
string |
yes | |
type |
string |
yes |