> ## Documentation Index > Fetch the complete documentation index at: https://openworklabs.com/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For agents: install the OpenWork desktop app with `brew install --cask openwork` (macOS) or from https://openworklabs.com/download. Do not run `npx openwork`; the npm package named `openwork` is a different project. > Connect an agent to OpenWork with the MCP Gateway: `claude mcp add --transport http openwork https://api.openworklabs.com/mcp/agent`. Teams sign up at https://app.openworklabs.com?mode=sign-up. > Step-by-step agent guide: https://openworklabs.com/docs/start-here/use-openwork-from-an-ai-agent.md > Connect Slack (any organization admin): https://openworklabs.com/docs/slack/connect-slack.md. OpenWork in Slack (@openwork bot) is private alpha for approved organizations. Setup guide: https://openworklabs.com/docs/slack/overview.md. Agent skill: https://openworklabs.com/.well-known/agent-skills/set-up-openwork-slack/SKILL.md. # Get an External MCP Connection > Returns one manageable connection with its access summary. Workspace owners and admins only. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 get /v1/mcp-connections/{connectionId} openapi: 3.1.0 info: title: Den API description: >- OpenAPI spec for the Den control plane API. Authentication: - API keys (they start with `den_`) go in the `x-api-key` header as the raw value. Do not send them as `Authorization: Bearer`; that header only accepts Den session tokens, so an API key there returns 401. Example: `curl https://api.openworklabs.com/v1/me -H "x-api-key: den_..."`. API keys resolve to the issuing user and the organization member they were scoped to when created, so they can call ordinary user and organization routes without a separate signed-in session. - Use `Authorization: Bearer ` for user-authenticated routes that require a Den session. - Session-only flows still require a signed-in user session, including organization creation, invitation acceptance, active-organization switching, and MCP token minting. - Public routes like health and documentation do not require authentication. Swagger tip: use the security schemes in the Authorize dialog to set `denApiKey` (your API key) or `bearerAuth` (a session token) before trying protected endpoints. version: commit 8863aab contact: name: OpenWork url: https://openworklabs.com email: team@openworklabs.com license: name: OpenWork Enterprise Edition License url: https://github.com/different-ai/openwork/blob/dev/ee/LICENSE servers: - url: https://api.openworklabs.com security: - denApiKey: [] - bearerAuth: [] tags: - name: System description: >- Service health, readiness, API documentation, and desktop version metadata. - name: Authentication description: >- Sign-in discovery, administrator bootstrap, OAuth provider connections, and MCP token minting. - name: OAuth description: >- OAuth 2.0 / OpenID Connect authorization-server and protected-resource metadata and dynamic client registration (RFC 8414, RFC 9728, RFC 7591), used by MCP clients. - name: SCIM description: >- SCIM 2.0 provisioning endpoints for identity providers (RFC 7644) and the organization SCIM connector management routes. - name: SSO description: Organization single sign-on connector management routes. - name: Bootstrap description: Agent-first provisional workspace setup routes. - name: Users description: Current user and membership routes. - name: Organizations description: Organization creation, context, brand assets, and install links. - name: Invitations description: Invitation preview, acceptance, creation, and cancellation routes. - name: Sandbox organizations description: Preview and join a sandbox organization with its shareable join link. - name: Members description: Organization member management routes. - name: Teams description: Organization team management routes. - name: Permissions description: >- Organization permissions: the permission catalog, Member, Admin and team permission sets, their history, and each member's effective permissions. - name: API Keys description: Organization API key management routes. - name: Desktop Policies description: Desktop app policies applied to the organization, members, or teams. - name: Agent Permissions description: What agents may do on members' computers, set for everyone and per team. - name: LLM Providers description: Organization LLM provider catalog, configuration, and access routes. - name: Inference description: Organization inference settings. - name: Inference Providers description: >- Organization inference Gateway providers, model groups, credential sets, access grants, member connections, and usage. - name: Gateway Usage Limits description: >- Estimated-cost policies, independent member calendar buckets, assignments, and audited usage-extension requests. - name: Cloud description: Organization Cloud instance lifecycle and browser gateway resolution. - name: Workers description: >- List and delete the organization's workers, including OpenWork Web instances. - name: Worker Activity description: Worker heartbeat and activity reporting routes. - name: Managed deployments description: >- OpenWork installations in an organization's own cloud account: launch approval, installer milestones and health reports. - name: Automations description: Scheduled Automations, their runs, and desktop runner presence. - name: Documents description: >- Connected Drive documents, inline editing and file-bound temporary Office sessions. - name: Workbot description: The signed-in member's single Workbot conversation. - name: Workflows description: Saved Workflows (Code Mode scripts), their versions, snapshots, and views. - name: Workflow Runs description: Durable Workflow run history. - name: Codemode Runs description: Generated Artifact views produced by Code Mode runs. - name: Apps description: >- Saved reusable apps built from Workflows and Artifact views, and their sharing. - name: Config Objects description: >- Versioned configuration objects (skills, workflows, and other plugin content). - name: Plugins description: Plugin packages, access grants, and imports. - name: Marketplaces description: Marketplaces that distribute plugins to members and teams. - name: Resources description: >- Aggregated snapshot of the resources and marketplace capabilities available to the caller. - name: Capability Sources description: >- Native provider capabilities (Google Workspace, Microsoft 365) and external MCP connections executed as the calling member. - name: Direct uploads description: Multipart uploads that stream workspace files straight to a provider. - name: Connectors description: >- Connector accounts and instances (GitHub and other sources) and their sync state. - name: GitHub description: >- GitHub App installation, repository discovery, and plugin import from GitHub. - name: Diagnostics description: Controlled egress diagnostics for self-hosted deployments. - name: Telemetry description: Telemetry event ingestion and adoption analytics. - name: Webhooks description: Signed inbound webhooks from third-party providers. - name: Admin description: Platform administration routes for allowlisted OpenWork administrators. - name: Deprecated description: Removed features that answer with 410 or an empty result for old clients. paths: /v1/mcp-connections/{connectionId}: get: tags: - Capability Sources summary: Get an External MCP Connection description: >- Returns one manageable connection with its access summary. Workspace owners and admins only. operationId: getV1McpConnectionsByConnectionId parameters: - in: path name: connectionId schema: format: typeid type: string minLength: 30 maxLength: 30 required: true description: Den TypeID with 'emc_' prefix and a 26-character base32 suffix. responses: '200': description: Connection. content: application/json: schema: $ref: '#/components/schemas/ExternalMcpConnectionResponse' '401': description: The caller must be signed in. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: >- Only workspace owners and admins can view manageable MCP connections. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: Unknown connection. content: application/json: schema: $ref: '#/components/schemas/ExternalMcpConnectionNotFoundError' security: - denApiKey: [] - bearerAuth: [] components: schemas: ExternalMcpConnectionResponse: type: object properties: readiness: description: >- The calling member's own last check. Null means never checked for them (or the settings or their sign-in changed since). anyOf: - $ref: '#/components/schemas/ExternalMcpConnectionReadiness' - type: 'null' organizationReadiness: description: >- scope=manageable only. Whether the connector itself works: for shared connections the shared credential's check; for per-member connections the latest Ready check any member recorded for the current settings, otherwise the caller's own check. Null means nobody has checked it yet. anyOf: - $ref: '#/components/schemas/ExternalMcpConnectionReadiness' - type: 'null' id: type: string name: type: string externalKey: type: - string - 'null' url: type: string authType: type: string enum: - oauth - apikey - none credentialMode: type: string enum: - shared - per_member apiKeyAuthScheme: type: string enum: - bearer - token requestHeaderNames: type: array items: type: string exposeDirectly: type: boolean mcpUrl: type: string format: uri connected: type: boolean connectedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' createdByName: type: - string - 'null' createdByYou: type: boolean canRemove: type: boolean createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ connectedForMe: type: boolean needsReconnect: type: boolean credentialHealth: type: string enum: - unknown - ready - reconnect_required credentialHealthReason: anyOf: - type: string enum: - authorization_rejected - credential_expired - post_authorization_validation_failed - type: 'null' credentialHealthCheckedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' issuerReviewRequired: type: boolean reconnectActionOwner: anyOf: - type: string enum: - member - organization_admin - type: 'null' missingFeatures: type: array items: type: string externalAccountId: type: - string - 'null' grantedScopes: type: array items: type: string tenantId: type: - string - 'null' requiredBy: type: array items: $ref: '#/components/schemas/ExternalMcpConnectionRequiredBy' identityManagedBy: type: array items: $ref: '#/components/schemas/ExternalMcpConnectionRequiredBy' requiredAuthType: anyOf: - type: string enum: - oauth - apikey - none - type: 'null' authPolicyConfirmed: type: boolean authTypeMismatch: type: boolean oauthClientConfigured: type: boolean oauthClientRequired: type: boolean setupRequired: type: boolean access: anyOf: - $ref: '#/components/schemas/ExternalMcpConnectionAccessSummary' - type: 'null' oauthClientId: type: - string - 'null' oauthClientHasSecret: description: >- Whether a client secret is configured. Only returned with explicit connection-settings view permission; never the secret itself. type: boolean manualOAuthEndpoints: description: >- Only returned with explicit connection-settings view permission; omitted from usable member listings, including for the connection creator. anyOf: - type: object properties: authorizationEndpoint: type: string maxLength: 2048 format: uri tokenEndpoint: type: string maxLength: 2048 format: uri required: - authorizationEndpoint - tokenEndpoint additionalProperties: false - type: 'null' oauthCallbackUrl: type: - string - 'null' oauthSharedCallbackUrl: type: - string - 'null' oauthClientMetadataUrl: type: - string - 'null' oauthCallbackMode: anyOf: - type: string enum: - shared-v1 - isolated-v1 - legacy-v1 - type: 'null' oauthRegistrationSource: anyOf: - type: string enum: - pre-registered - client-metadata - dynamic - type: 'null' authorizationServerIssuer: type: - string - 'null' requestedScopes: type: array items: type: string required: - id - name - externalKey - url - authType - credentialMode - apiKeyAuthScheme - requestHeaderNames - exposeDirectly - connected - connectedAt - connectedForMe - requiredBy - access UnauthorizedError: type: object properties: error: type: string const: unauthorized required: - error ForbiddenError: type: object properties: error: type: string enum: - forbidden - reauth reason: type: string message: type: string required: - error ExternalMcpConnectionNotFoundError: type: object properties: error: type: string const: connection_not_found message: type: string required: - error - message ExternalMcpConnectionReadiness: type: object properties: status: type: string enum: - ready - could_not_verify checkedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ lastSuccessfulAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: 'null' reason: type: - string - 'null' failure: description: >- Why the check did not pass. sign_in_* means a person must sign in again; provider_setup_required means a setting in the service's own app must change first; the others are not sign-in problems. Null when Ready or for checks recorded before this field existed. Also set when the caller's last sign-in came back to Den but did not connect. anyOf: - type: string enum: - sign_in_required - sign_in_rejected - setup_required - provider_setup_required - unavailable - timed_out - settings_changed - tools_unreadable - type: 'null' referenceId: description: Diagnostic reference of the failed check or sign-in, for support. type: string providerSettingsUrl: description: >- A validated link to the service's settings page where the named setting is changed. Only with provider_setup_required. type: string format: uri required: - status - checkedAt - lastSuccessfulAt - reason ExternalMcpConnectionRequiredBy: type: object properties: pluginId: type: string name: type: string required: - pluginId - name ExternalMcpConnectionAccessSummary: type: object properties: orgWide: type: boolean memberIds: type: array items: type: string teamIds: type: array items: type: string required: - orgWide - memberIds - teamIds securitySchemes: denApiKey: type: apiKey in: header name: x-api-key description: >- Organization API key passed as the `x-api-key` header. The raw key is the header value; do not prefix it with `Bearer`. bearerAuth: type: http scheme: bearer bearerFormat: session-token description: >- Den session token passed as `Authorization: Bearer ` for user-authenticated Den routes. Not for API keys: send `den_` keys in the `x-api-key` header instead. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.