Get accessible connector

Outcome

Reads connector configuration only when Auth grants the caller the associated application. Configuration in Agent’s database does not itself grant access.

Before you start

• Verify the intended environment, authenticated identity and organization before discovery.
• Discover the published workspace:read application permission and inspect the credential-scoped action contract.
• Discover and bind the granted canonical Agent workspace separately from the action input.
• Fixture identifiers and simulated responses confer no live access. Replace identifiers through granted resource discovery.

Discover the target

• topolo whoami --json
• topolo workspaces list topolo-agent --json
• topolo actions get app_topolo_agent.connectors.get --detail --json
• Read app_topolo_agent.connectors.list in this same authorized context and select the returned identifier. Do not derive ids from display names.
• Inspect app_topolo_agent.connectors.list in the same credential and resource context before reading it.

Request

GET /api/connectors/{id}

Input fields

Worked examples

Worked response 1 · HTTP 200

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.

Input · payload.json:

{
  "id": "connector_docs_fixture"
}

CLI:

topolo actions validate app_topolo_agent.connectors.get --data @payload.json --json
topolo actions plan app_topolo_agent.connectors.get --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_agent.connectors.get --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_agent.connectors.get",
    "input": {
      "id": "connector_docs_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "success": true,
  "connector": {
    "id": "connector_docs_fixture",
    "slug": "fixture-documents",
    "name": "Fixture Documents",
    "appId": "app_docs_fixture",
    "baseUrl": "https://documents.docs.test",
    "status": "active",
    "capabilities": [],
    "requiredScopes": [],
    "onboardingSchema": {
      "title": "Fixture Documents onboarding",
      "description": "Capture the operating context Fixture Documents needs before Topolo Agent starts executing work in this app.",
      "completionLabel": "Complete Fixture Documents onboarding",
      "fields": [
        {
          "key": "operatingModel",
          "label": "Operating model",
          "type": "textarea",
          "required": true,
          "prompt": "What should Fixture Documents help the organization do first?"
        },
        {
          "key": "primaryObjectives",
          "label": "Primary objectives",
          "type": "list",
          "required": true,
          "prompt": "What are the primary objectives for Fixture Documents? You can list more than one."
        },
        {
          "key": "keyWorkflows",
          "label": "Key workflows",
          "type": "list",
          "required": true,
          "prompt": "Which workflows or jobs should Fixture Documents own first?"
        },
        {
          "key": "approvalExpectations",
          "label": "Approval expectations",
          "type": "textarea",
          "required": true,
          "prompt": "What actions in Fixture Documents should require explicit approval before execution?"
        },
        {
          "key": "reportingFocus",
          "label": "Reporting focus",
          "type": "list",
          "required": true,
          "prompt": "Which outputs or reporting views matter most in Fixture Documents?"
        },
        {
          "key": "constraints",
          "label": "Constraints",
          "type": "textarea",
          "required": false,
          "prompt": "What constraints, rules, or operator preferences should Fixture Documents remember?"
        }
      ]
    },
    "created_at": 1,
    "updated_at": 1
  }
}

successful: HTTP 200; seeded local fixture identifiers confer no live access.

Worked response 2 · HTTP 401

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.

Input · payload.json:

{
  "id": "connector_docs_fixture"
}

CLI:

topolo actions validate app_topolo_agent.connectors.get --data @payload.json --json
topolo actions plan app_topolo_agent.connectors.get --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_prepare_action",
  "arguments": {
    "actionId": "app_topolo_agent.connectors.get",
    "input": {
      "id": "connector_docs_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 401:

{
  "success": false,
  "error": "Organization context required"
}

organization context missing: HTTP 401; SDK code auth_error; seeded local fixture identifiers confer no live access.

Worked response 3 · HTTP 404

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.

Input · payload.json:

{
  "id": "connector_docs_fixture"
}

CLI:

topolo actions validate app_topolo_agent.connectors.get --data @payload.json --json
topolo actions plan app_topolo_agent.connectors.get --resource-type workspace --resource-id "$AGENT_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_prepare_action",
  "arguments": {
    "actionId": "app_topolo_agent.connectors.get",
    "input": {
      "id": "connector_docs_fixture"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>"
  }
}

Captured local response · HTTP 404:

{
  "success": false,
  "error": "Connector not found"
}

connector not entitled: HTTP 404; SDK code http_error; seeded local fixture identifiers confer no live access.

Verify the result

• Compare connector.id, appId, slug, baseUrl and status against connectors.list for the same credential and organization. Stored onboarding fields describe required context; this read does not onboard the application.

Errors and recovery

• auth_error (HTTP 401): For an unstructured HTTP 401 response, authenticate and verify the intended organization and workspace before retrying.
• permission_denied (HTTP 403): For an unstructured HTTP 403 response, use the published application permission and required resource-level access. Do not retry with broader context.
• http_error (HTTP 404): For an unstructured HTTP 404 response, refresh the corresponding resource listing in the same context. Private resources can be deliberately hidden from this caller.

Authentication, input validation or resource middleware can refuse a request before these handlers. Preserve the actual refusal and request id.

Recovery boundary

This read does not change service state. Re-discover the target in the same authorized organization and workspace after a missing or hidden-resource refusal; do not guess identifiers or widen context.

Related actions

• Connectors List: List the connectors available to the workspace and which are configured.

Evidence

Actual exported read handlers and replayed SQLite migrations. Auth directory, service-token, R2 object storage and Durable Object storage boundaries are simulated; session response serialization executes the actual AgentSession.onRequest method. Egress is sealed. No deployed/provider outcome or live access is demonstrated.