Skip to main content
Glama

get_oauth_client

Read-onlyIdempotent

Retrieve details of a single OAuth client by ID to check its active status, permitted scopes, and IP allowlist. Identifies whether the client can still obtain tokens and what actions it can perform.

Instructions

Inspect one API client: what it may do, and whether it still works.

    `id` is the client's record id from `list_oauth_clients`, not its `client_id`
    (the value used when authenticating). Both are on the row.

    `is_active` false means the client has been deactivated and can no longer obtain
    a token. `scope_codenames` is exactly what it may do; `ip_allowlist`, when
    non-empty, is where it may do it from.

    No secret is returned. There is no way to read one back.

    Requires the `clients:read` OAuth scope, and the `admin` capability profile.
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
nameNo
warningNo
client_idNo
is_activeNo
created_atNo
descriptionNo
ip_allowlistNo
client_secretNo
scope_codenamesNo
Install Server

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the readOnlyHint/idempotentHint annotations, the description reveals that no secret is ever returned and that there is no way to read one back, a critical behavioral constraint. It also explains the semantics of is_active, scope_codenames, and ip_allowlist, giving the agent clear expectations about the response.

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 a focused set of short paragraphs that front-load the purpose, then cover the parameter nuance, field meanings, secret non-return, and authorization requirements. Every sentence earns its place; there is no padding or repetition.

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

Completeness5/5

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

For a single-parameter read tool with an output schema and readOnly/idempotent annotations already provided, the description is complete: it defines the parameter, the meaningful response fields, the non-return of secrets, and required auth. No significant gap remains for correct invocation.

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

Parameters5/5

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

The schema only defines id as a string with no description, so 0% coverage places the burden on the description. The description fully compensates by clarifying that id is the internal record id from list_oauth_clients, not the OAuth client_id used for authentication, which is exactly the distinction needed to call this tool correctly.

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 opening sentence 'Inspect one API client: what it may do, and whether it still works' names a specific verb and resource, making the tool's function immediately clear. It distinguishes itself from list_oauth_clients by focusing on a single client, so an agent can tell which getter to use.

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 provides clear context by stating the required clients:read OAuth scope and admin capability profile, and it identifies the id source as list_oauth_clients. However, it does not explicitly contrast with siblings like update_oauth_client or list_oauth_clients with when-not statements, so the routing guidance is implied rather than fully explicit.

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

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/CloudSecurityAlliance/csa-skilljar'

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