admin
title: Administration sidebar_label: Administration (5) sidebar_position: 10 doc_type: reference
Administration
Overview
Check system health and maintenance statistics.
Prerequisites
- API key with the MCP preset and required scopes
- Configured MCP client (see Configuration)
Quick start examples
Check system health
- Check overall health :
{
"name": "admin_health",
"arguments": {}
}
- View circuit breaker status :
{
"name": "admin_circuit_breaker_status",
"arguments": {}
}
admin_circuit_breaker_status
Get the status of all circuit breakers in the system.
USE WHEN:
- Need to check if any external services are failing
- Need to see which circuit breakers are open
- Debugging connectivity issues RETURNS: summary (healthy/unhealthy counts) and per-breaker status.
| Scope | mcp.read |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
Response
| Field | Type | Description |
|---|---|---|
breakers | record |
Related tools :
admin_health,admin_dlq_stats
admin_dlq_stats
Get statistics about the Dead Letter Queue (DLQ) for failed outbox events.
USE WHEN:
- Need to check if there are failed events in the DLQ
- Need to see common error patterns
- Need to monitor event processing health RETURNS: total events, breakdown by workspace/type, common errors.
| Scope | mcp.read |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
workspaceId | string (uuid) | No | Filter stats by workspace ID |
Related tools :
admin_health,admin_projection_stats
admin_health
[DISCOVERY] Get system health overview with database and event store statistics.
USE WHEN:
- Need to check if the system is healthy
- Need database connection pool statistics
- Need event store metrics RETURNS: health status, database info, event store stats.
| Scope | mcp.read |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
Response
| Field | Type | Description |
|---|---|---|
status | enum |
Example
{
"name": "admin_health",
"arguments": {}
}
Related tools :
admin_circuit_breaker_status,admin_projection_stats,admin_dlq_stats
admin_orphan_cleanup
Detect and clean up orphan edges (edges referencing non-existent nodes).
USE WHEN:
- Need to check for orphan edges in the graph
- Need to clean up orphan data after deletions RETURNS: orphan statistics or cleanup results. NOTE: dryRun defaults to true for safety — set to false to actually delete.
| Scope | mcp.write |
| Read-only | No |
| Destructive | Yes |
| Idempotent | No |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
action | choice (detect, cleanup) | Yes | Action: detect (stats only) or cleanup (remove orphans) |
dryRun | boolean | No | If true with cleanup action, report what would be deleted without actually deleting (default: true) |
includeDeletedNodes | boolean | No | Include edges to soft-deleted nodes (default: false) |
limit | number | No | Max orphans to clean up (default: 1000) |
Related tools :
admin_health,admin_projection_stats
admin_projection_stats
Get event store and projection statistics.
USE WHEN:
- Need to see how many events are in the store
- Need to check event distribution by type
- Need to monitor outbox health RETURNS: total events, events by type, stream count, date range, outbox stats.
| Scope | mcp.read |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
Response
| Field | Type | Description |
|---|---|---|
totalEvents | number | |
eventsByType | array | |
streamCount | number |
Related tools :
admin_health,admin_dlq_stats
Need help?
Contact us: Support and contact.