> ## 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. # Resolve a free-form query to an MCP server > Admin-only, side-effect-free smart resolution for the add-connection flow. Accepts a URL, a bare host, or a product name ("vercel"), matches curated presets, probes bounded well-known endpoint candidates through the SSRF-guarded discovery fetch, and returns the winning URL with its requirements discovery. It performs no client registration, credential write, or connection creation. ## OpenAPI ````yaml https://api.openworklabs.com/openapi.json?public=1 post /v1/mcp-connections/resolve 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 7bee9d4 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/resolve: post: tags: - Authentication summary: Resolve a free-form query to an MCP server description: >- Admin-only, side-effect-free smart resolution for the add-connection flow. Accepts a URL, a bare host, or a product name ("vercel"), matches curated presets, probes bounded well-known endpoint candidates through the SSRF-guarded discovery fetch, and returns the winning URL with its requirements discovery. It performs no client registration, credential write, or connection creation. operationId: postV1McpConnectionsResolve requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExternalMcpResolveInput' responses: '200': description: Resolution result (not_found is a successful outcome). content: application/json: schema: $ref: '#/components/schemas/ExternalMcpResolveResult' '400': description: Invalid request. content: application/json: schema: $ref: '#/components/schemas/InvalidRequestError' '401': description: The caller must be signed in. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Only workspace owners and admins can resolve MCP servers. content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' security: - denApiKey: [] - bearerAuth: [] components: schemas: ExternalMcpResolveInput: type: object properties: query: type: string minLength: 1 maxLength: 200 required: - query ExternalMcpResolveResult: type: object properties: resolution: type: string enum: - preset - discovered - not_found attempted: type: array items: type: string reason: type: string preset: $ref: '#/components/schemas/ExternalMcpPresetResponse' match: type: object properties: url: type: string suggestedName: type: string discovery: $ref: '#/components/schemas/ExternalMcpRequirementsDiscovery' required: - url - suggestedName - discovery required: - resolution - attempted InvalidRequestError: type: object properties: error: type: string const: invalid_request message: type: string details: type: array items: type: object properties: message: type: string path: type: array items: type: - string - number required: - message additionalProperties: {} capability: type: string required: - error - details 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 ExternalMcpPresetResponse: type: object properties: presetId: type: string displayName: type: string description: type: string url: type: string authType: type: string enum: - oauth - apikey - none supportedAuthTypes: type: array items: type: string enum: - oauth - apikey - none requiresOAuthClient: type: boolean defaultOAuthClientId: type: string minLength: 1 authorizationServerIssuer: type: string format: uri defaultOAuthScopes: type: array items: type: string optionalOAuthScopes: description: >- Extra scopes the provider offers. Never requested by default; setup requests them only after an admin explicitly chooses them. type: array items: type: string registrationStatus: type: string enum: - client_metadata - dynamic_open - dynamic_refused - requires_client - no_auth - unknown oauthCallbackUrl: description: >- For presets that need a pre-registered OAuth app: the exact redirect URL to register in it. Absent when this deployment has no public API URL. type: string format: uri required: - presetId - displayName - description - url - authType ExternalMcpRequirementsDiscovery: type: object properties: publishedSignInAddresses: description: >- Settings-view-only unverified suggestions; never applied until an administrator saves manual sign-in settings. type: array items: type: object properties: authorizationEndpoint: type: string maxLength: 2048 format: uri tokenEndpoint: type: string maxLength: 2048 format: uri advertisedIssuer: type: string metadataIssuer: type: string required: - authorizationEndpoint - tokenEndpoint - advertisedIssuer - metadataIssuer additionalProperties: false status: type: string enum: - ready - manual_action_required - unsupported - unreachable server: type: object properties: url: type: string protocolVersion: type: string initialize: type: string enum: - succeeded - authentication_required - failed required: - url - initialize authentication: type: object properties: kind: type: string enum: - none - oauth - manual_bearer - unknown resource: type: string protectedResourceMetadataUrl: type: string authorizationServers: type: array items: type: object properties: issuer: type: string authorizationEndpoint: type: string tokenEndpoint: type: string registrationEndpoint: type: string clientIdMetadataDocumentSupported: type: boolean scopesSupported: type: array items: type: string grantTypesSupported: type: array items: type: string codeChallengeMethodsSupported: type: array items: type: string tokenEndpointAuthMethodsSupported: type: array items: type: string required: - issuer - clientIdMetadataDocumentSupported requiredScopes: type: array items: type: string resourceScopesSupported: description: >- Protected-resource scope advertisement, separate from the authentication challenge's required scopes. type: array items: type: string recommendedScopes: type: array items: type: string refreshSupport: type: string enum: - supported - not_advertised - unknown availableRegistrationMethods: type: array items: type: string enum: - pre_registered - client_metadata - dynamic recommendedRegistrationMethod: type: string enum: - client_metadata - dynamic - pre_registered required: - kind - authorizationServers - requiredScopes - recommendedScopes - refreshSupport - availableRegistrationMethods - recommendedRegistrationMethod tools: type: object properties: visibility: type: string enum: - available_without_auth - requires_auth - unavailable count: type: integer minimum: 0 maximum: 9007199254740991 items: type: array items: type: object properties: name: type: string readOnlyHint: type: boolean destructiveHint: type: boolean openWorldHint: type: boolean required: - name required: - visibility manualRequirements: type: array items: type: object properties: code: type: string label: type: string reason: type: string required: type: boolean required: - code - label - reason - required warnings: type: array items: type: object properties: code: type: string message: type: string required: - code - message required: - status - server - authentication - tools - manualRequirements - warnings 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.