Skip to main content
Glama

Verify GitHub credential

verify_github_credential
Read-only

Verify a GitHub App credential's connection by probing the installation (token mint, API reachability, repository access) and report each check's outcome. Only works for GitHub App backed credentials. Read-only.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "credential_id": "<credential_id>"
    },
    "name": "verify_github_credential"
  }
}

Input Schema

NameRequiredDescriptionDefault
credential_idYesUUID of the GitHub credential to verify.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Beyond readOnlyHint, the description discloses the three probes performed and that each check's outcome is reported, which is useful operational and result context. “Read-only” merely repeats the annotation, and details such as partial-failure behavior or the temporary token's lifecycle are not covered.

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 purpose and concrete checks are front-loaded in one compact sentence, followed immediately by the important compatibility restriction. The final “Read-only” sentence is slightly redundant with the structured annotation, but there is otherwise no unnecessary wording.

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 simple, one-parameter read-only diagnostic, the definition supplies the operation, supported credential type, checks performed, reporting granularity, and safety posture. Although no output schema exists, “report each check's outcome” gives enough return-value context for correct selection and invocation.

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

Parameters4/5

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

The schema already fully documents credential_id as a UUID, establishing the baseline. The description adds a meaningful constraint on that value by requiring the referenced credential to be GitHub App-backed, though it does not point to list_credentials or get_credential for ID discovery.

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 pairs a specific verb and resource with concrete behavior: verifying a GitHub App credential by probing token minting, API reachability, and repository access. This active connection testing clearly differentiates it from passive siblings such as get_credential, get_github_credential_activity, and get_github_credential_usages.

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?

“Only works for GitHub App backed credentials” provides an explicit eligibility restriction and prevents selection for unsupported credential types. It does not explain when verification is preferable to inspecting credential metadata or where to route non-App credentials, so workflow guidance is not exhaustive.

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.