Skip to main content
Glama

token_exchange_api_v1_auths_oauth

Exchange an external OAuth provider token for an OpenWebUI JWT to authenticate.

Instructions

Exchange an external OAuth provider token for an OpenWebUI JWT. This endpoint is disabled by default. Set ENABLE_OAUTH_TOKEN_EXCHANGE=True to enable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
providerYes
tokenYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailYes
expires_atNo
idYes
nameYes
permissionsNo
profile_image_urlYes
roleYes
tokenYes
token_typeYes
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description must disclose behavior. It only mentions the disabled-by-default trait. It omits details about idempotency, side effects (e.g., token invalidation), or error conditions, leaving significant gaps for an auth-related operation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise (two sentences) and front-loads the purpose. However, it could benefit from a brief parameter explanation without becoming verbose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the schema coverage is zero and annotations are absent, the description is incomplete. Key details like provider options, token validation requirements, and typical response structure (despite output schema existing) are missing, limiting the agent's ability to use it confidently.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0% schema description coverage, the description adds no meaning to the parameters. It doesn't clarify valid provider values, token format, or constraints, forcing reliance on the raw schema alone.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Exchange') and the resources ('external OAuth provider token for an OpenWebUI JWT'), which is specific and distinct from sibling tools like signin/signup or other OAuth flows.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides critical usage guidance: the endpoint is disabled by default and requires an environment variable to enable. However, it doesn't explicitly contrast with alternative authentication methods or specify when to use this vs. other OAuth endpoints.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/TETRA-2023/open-webui-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server