Appearance
agents.mcp-server.test-connection ​
Test reachability and credentials for a registered MCP server
Probe a registered MCP server with its stored credential.
Backs the "Test connection" button: it answers "will my agents actually be able to call this?" without waiting for a session to fail mid-run. Writes the verdict to auth_status so the list view can badge it.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-agents |
| Version | 1.0 |
Triggers ​
| Source | Endpoint / Event | Description |
|---|---|---|
| API | POST /api/agents/mcp-servers | API — manage MCP server registrations |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
mcp_server_uuid | string | Yes | — | — |
organization_uuid | string | Yes | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
failed_at_state | string | No | — | — |
failed_layer | json | No | — | — |
failed_step | string | No | — | — |
failure_reason | string | No | — | — |
mcp_server_uuid | json | No | — | — |
organization_uuid | json | No | — | — |
reachable | boolean | No | — | — |
auth_status | string | No | — | — |
transport | json | No | — | — |
tools_count | json | No | — | — |
detail | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | run | — |
run | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | run | run | — |
run | complete | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
tested | SUCCESS | MCP server connection tested | mcp_server_uuid, reachable, auth_status, tools_count |
failed | FAILURE | MCP server connection tested failed | failure_reason, error, error_type, failed_at_state, failed_step, failed_layer |
Business Errors ​
| Code | Message Template |
|---|---|
AGENTS_ORGANIZATION_CONTEXT_INVALID | Authenticated organization context is missing or does not match the workflow input |
AGENTS_MCP_SERVER_NOT_FOUND | MCP server {mcp_server_uuid} was not found in the organization |
AGENTS_MCP_AUTH_REJECTED | MCP server {mcp_server_uuid} rejected the stored credential |
AGENTS_MCP_AUTH_EXPIRED | The OAuth grant for MCP server {mcp_server_uuid} has expired and cannot be refreshed; the organization must re-authorize it |
AGENTS_VALIDATION_FAILED | Workflow input or domain state failed validation: |
AGENTS_CONFLICT | Conflicting agent domain state: |
AGENTS_PROVIDER_FAILED | Upstream provider or runner call failed: |
AGENTS_MCP_CALL_FAILED | MCP tool call failed for {tool_name}: |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "agents.mcp-server.test-connection",
"initial_data": {
"mcp_server_uuid": "value",
"organization_uuid": "value"
}
}