End User MCP Server

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

OAuth is the recommended way to connect. The OAuth commands below sign you in to Opal in your browser — no stored secret. Find your Client ID under User → Settings → OAuth Grants (app.opal.dev/user/settings/oauth-grants); if your client asks for a resource or audience value, read it from this server’s protected-resource metadata at https://app.opal.dev/.well-known/oauth-protected-resource/mcp/end-user. See Authentication for details. To use an API token instead, create one first.

Self-hosted Opal deployments can host MCP servers as of version v1.1135.0. If you run self-hosted, remember to replace https://app.opal.dev with your own domain.

Claude Code
Cursor
Gemini CLI
Other

OAuth (recommended): add the server with no Authorization header, then sign in.

claude mcp add --transport http opal-end-user https://app.opal.dev/mcp/end-user

claude mcp login opal-end-user

Claude Code also prompts you to sign in the first time it calls a tool from this server. Check server status any time with claude /mcp.API token: pass the token as a header when you add the server.

claude mcp add --transport http opal-end-user https://app.opal.dev/mcp/end-user --header "Authorization: Bearer ${OPAL_API_TOKEN}"

To learn more, see Claude Code documentation.

OAuth (recommended): add the following to your ~/.cursor/mcp.json file, with no Authorization header:

{
  "mcpServers": {
    "opal-end-user": {
      "transport": "http",
      "url": "https://app.opal.dev/mcp/end-user"
    }
  }
}

Open Cursor Settings → MCP, and click Needs login next to the server to sign in through your browser.API token: add an Authorization header instead.

{
  "mcpServers": {
    "opal-end-user": {
      "transport": "http",
      "url": "https://app.opal.dev/mcp/end-user",
      "headers": {
        "Authorization": "Bearer ${env:OPAL_API_TOKEN}"
      }
    }
  }
}

Define your OPAL_API_TOKEN, and make sure you open Cursor from the same shell.

export OPAL_API_TOKEN="secret"

open -a Cursor

To learn more, see Cursor documentation.

OAuth (recommended): add the following to your ~/.gemini/settings.json, with no Authorization header, then follow the sign-in prompt on first use:

{
  "mcpServers": {
    "opal-end-user": {
      "httpUrl": "https://app.opal.dev/mcp/end-user"
    }
  }
} 

API token: add an Authorization header instead.

{
  "mcpServers": {
    "opal-end-user": {
      "httpUrl": "https://app.opal.dev/mcp/end-user",
      "headers": {
        "Authorization": "Bearer ${OPAL_API_TOKEN}"
      }
    }
  }
}

To learn more, see Gemini documentation.

MCP is an open protocol supported by many other clients, and your specific client documentation can advise you how to connect. Key inputs:

Transport http
Endpoint https://app.opal.dev/mcp/end-user
OAuth (recommended): omit the Authorization header — most clients discover Opal’s OAuth support automatically and prompt you to sign in.
API token: add the header Authorization: Bearer ${OPAL_API_TOKEN}.

Available Tools

Tool	Description
`opal_get_resources`	Returns a list of resources for your organization.
`opal_user`	Retrieves detailed user information from Opal. This endpoint is designed to fetch user details by either user ID (UUID) or email address.
`opal_get_users`	Returns a list of users for your organization.
`opal_get_resource_nhis`	Gets the list of non-human identities with access to this resource.
`opal_create_request`	Create an access request.
`opal_get_resource_users`	Gets the list of users for this resource.
`opal_get_requests`	Returns a list of requests for your organization that is visible by the admin.
`opal_get_request`	Returns a request by ID.
`opal_get_group_users`	Gets the list of users for this group.
`opal_get_groups`	Returns a list of groups for your organization.
`opal_get_group_containing_groups`	Gets the list of groups that the group gives access to.
`opal_get_group_resources`	Gets the list of resources that the group gives access to.
`opal_get_group`	Returns a `Group` object.
`opal_get_bundle_groups`	Returns a list of `Group` objects in a given bundle.
`opal_get_bundle_resources`	Returns a list of `Resource` objects in a given bundle.
`opal_get_apps`	Returns a list of `App` objects.
`opal_get_bundles`	Returns a list of `Bundle` objects.
`opal_get_bundle`	Returns a `Bundle` object.

Tool Parameters

opal_get_resources

Param	Type	Notes
`name_filter`	string	required. Text search on resource name
`resource_types`	string[]	Optional: restrict results to these resource types
`connection_ids`	string[]	Optional: restrict results to these connection IDs

opal_user

Param	Type	Notes
`email`	string	The email address of the user to look up

opal_get_users

Param	Type	Notes
`cursor`	string	Opaque pagination cursor from a previous response
`page_size`	integer	Maximum number of users to return (default 100)

opal_get_resource_nhis

Param	Type	Notes
`resource_id`	string	required. UUID of the resource

opal_create_request

Param	Type	Notes
`reason`	string	required. Reason for the access request
`resource_ids`	string[]	UUIDs of resources to request access to
`group_ids`	string[]	UUIDs of groups to request access to
`duration_minutes`	integer	Duration of access in minutes
`target_user_id`	string	UUID of user to request access on behalf of (defaults to the requesting user)

opal_get_resource_users

Param	Type	Notes
`resource_id`	string	required. UUID of the resource

opal_get_requests

Param	Type	Notes
`entity_ids`	string[]	UUIDs of users or groups involved in the requests
`requester_ids`	string[]	UUIDs of users who made the requests
`target_user_ids`	string[]	UUIDs of users the requests are for
`search_query`	string	Search query to filter requests
`start_date`	string	Filter requests created after this date (RFC3339 format)
`end_date`	string	Filter requests created before this date (RFC3339 format)
`show_pending_only`	boolean	Only show pending requests
`cursor`	string	Opaque pagination cursor from previous response
`limit`	integer	Maximum number of requests to return (default: 100, max: 1000)

opal_get_request

Param	Type	Notes
`request_id`	string	required. UUID of the access request

opal_get_group_users

Param	Type	Notes
`group_id`	string	required. UUID of the group

opal_get_groups

Param	Type	Notes
`name_filter`	string	required. Text search on group name
`connection_ids`	string[]	Optional: restrict results to these connection IDs

opal_get_group_containing_groups

Param	Type	Notes
`group_id`	string	required. UUID of the member group to find containing (parent) groups for

opal_get_group_resources

Param	Type	Notes
`group_id`	string	required. UUID of the group

opal_get_group

Param	Type	Notes
`group_id`	string	required. UUID of the group to look up

opal_get_bundle_groups

Param	Type	Notes
`bundle_id`	string	required. UUID of the bundle

opal_get_bundle_resources

Param	Type	Notes
`bundle_id`	string	required. UUID of the bundle

opal_get_apps

Param	Type	Notes
`search_query`	string	Text search on app name

opal_get_bundles

Param	Type	Notes
`search_query`	string	Text search on bundle name

opal_get_bundle

Param	Type	Notes
`bundle_id`	string	required. UUID of the bundle

Welcome

End user

Getting Started

Access Management

AI Agent Governance

OpalScript

Paladin

OpalQuery

Auditing and Security

Custom Integrations

For Developers

Installation

Available Tools

Tool Parameters

​Installation

​Available Tools

​Tool Parameters

Installation

Available Tools

Tool Parameters