Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.opal.dev/llms.txt

Use this file to discover all available pages before exploring further.

Opal’s End User MCP provides a set of tools that enables end users to leverage AI agents to request access to Opal resources, groups, and bundles . Use cases include:
  • Browse available resources, groups, and bundles
  • Create access requests for yourself or as part of a workflow
  • Check request status and view your current access
  • Use in combination with other MCP servers (e.g., request access to Retool, then use Retool’s MCP server to query data)

Installation

First, create an API Token in your Opal environment. Then, select a method and follow the instructions below.
If you run self-hosted, remember to replace https://app.opal.dev to your own domain.
To install, run the following command in your shell:
claude mcp add --transport http opal-end-user https://app.opal.dev/mcp/end-user --header "Authorization: Bearer ${OPAL_API_TOKEN}" 
Then authenticate with Opal.
claude /mcp
To learn more, see Claude Code documentation.

Available Tools

ToolDescription
opal_get_resourcesReturns a list of resources for your organization.
opal_userRetrieves detailed user information from Opal. This endpoint is designed to fetch user details by either user ID (UUID) or email address.
opal_get_usersReturns a list of users for your organization.
opal_get_resource_nhisGets the list of non-human identities with access to this resource.
opal_create_requestCreate an access request.
opal_get_resource_usersGets the list of users for this resource.
opal_get_requestsReturns a list of requests for your organization that is visible by the admin.
opal_get_requestReturns a request by ID.
opal_get_group_usersGets the list of users for this group.
opal_get_groupsReturns a list of groups for your organization.
opal_get_group_containing_groupsGets the list of groups that the group gives access to.
opal_get_group_resourcesGets the list of resources that the group gives access to.
opal_get_groupReturns a Group object.
opal_get_bundle_groupsReturns a list of Group objects in a given bundle.
opal_get_bundle_resourcesReturns a list of Resource objects in a given bundle.
opal_get_appsReturns a list of App objects.
opal_get_bundlesReturns a list of Bundle objects.
opal_get_bundleReturns a Bundle object.
Last modified on May 14, 2026