Skip to main content
Glama

clerk.get_instance_oauth_settings

Retrieve OAuth settings for a connected Clerk instance.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns OAuth settings.

Cost = 3 tokens.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
clerk_instance_idNoClerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
oauth_settingsNoClerk instance OAuth settings from the Backend API.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden of disclosing behavior. It states that the tool 'Returns OAuth settings' and discloses a token cost, adding transparency. The phrase 'Retrieve' implies a read-only operation, though it does not explicitly state that no changes are made. It also highlights a dependency on get_connected_accounts, which is helpful.

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

Conciseness5/5

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

The description is three brief sentences plus a cost note, all front-loaded with the main action. Every sentence adds value—purpose, prerequisite, return, and cost. It is concise without being under-specified.

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

Completeness4/5

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

For a simple getter with one optional parameter and an output schema, the description covers the essential context: what it retrieves, how to prepare (get_connected_accounts), and how to target an instance. It omits explicit error scenarios or comparison with the update counterpart, but the presence of an output schema reduces the need to describe return values. Overall, it is sufficient for correct invocation.

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

Parameters3/5

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

The input schema already describes clerk_instance_id thoroughly, including its format and default behavior. The description's parameter guidance ('Pass clerk_instance_id to target a specific connection, or omit it to use the default account') largely mirrors the schema, adding minimal new information. With 100% schema coverage, the baseline is 3, and no compensating detail is provided in the description.

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 opens with 'Retrieve OAuth settings for a connected Clerk instance,' using a specific verb and resource. It clarifies that this targets connected Clerk instances, distinguishing it from sibling tools like clerk.get_instance_settings and clerk.update_instance_oauth_settings. The name itself reinforces the OAuth scope.

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?

The description explicitly instructs to 'Call clerk.get_connected_accounts first,' providing a clear prerequisite. It also explains how to target a specific connection via clerk_instance_id or fall back to the default account. However, it does not explicitly mention alternatives for modification (e.g., clerk.update_instance_oauth_settings) or state when not to use this tool.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.1/5.0
Disambiguation5/5

Each tool has a distinct purpose, further clarified by group prefixes and clear descriptions. Within each group, tools perform different operations (e.g., domains.lookup vs. domains.whois vs. domains.rdap) with no ambiguity.

Naming Consistency5/5

All tools follow a consistent group.tool_name pattern using snake_case. The naming is predictable and uniformly applied across all groups.

Tool Count4/5

78 tools is high, but the server aggregates multiple distinct API domains (11 groups). Each group has a reasonable number of tools, typically under 10, with TikTok having 17. The count reflects breadth, not bloat.

Completeness5/5

Each domain's tool set covers the primary expected operations (e.g., search, details, reviews, metrics, user info). There are no obvious gaps for read-only analytical use; features like posting are likely out of scope.