Skip to main content
Glama

Get GitHub credential usages

get_github_credential_usages
Read-only

List everything that depends on a GitHub credential: the clusters whose GitOps repository rides it (any cluster, imported or Ankra-provisioned) and the Applications built from repositories it grants. Use this before planning a credential replacement or deletion. usage_count counts clusters, application_count counts Applications, and dependent_count is the total to weigh before deleting. Dependents are matched by credential name, so when ambiguous_credential_name is true the list spans every credential sharing that name. 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": "get_github_credential_usages"
  }
}

Input Schema

NameRequiredDescriptionDefault
credential_idYesUUID of the GitHub credential.

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?

Annotations already declare readOnlyHint=true, so the trailing "Read-only" adds nothing; however, the description supplies behavior annotations cannot: the meaning of usage_count, application_count, and dependent_count, and the important caveat that dependents are matched by credential name so ambiguous_credential_name=true widens the result set. With no output schema, these field definitions are the only place the return shape is documented. Missing only error/no-match behavior.

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?

Purpose is front-loaded in the first sentence, followed by usage timing, then the count-field definitions and the ambiguity caveat. Four dense sentences with no filler, though the count glossary is terse enough that a reader must track three similar field names at once.

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 one-parameter read-only lookup with no output schema, the description covers what is returned (clusters, Applications), how counts aggregate, and the name-collision edge case. Nothing material an agent needs to plan a credential deletion is missing.

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?

Schema coverage is 100% and the single credential_id parameter is documented as a UUID, so baseline would be 3. The description goes beyond that by explaining that the ID resolves to a credential name and that name collisions expand the returned set, which changes how an agent should interpret results for a given credential_id.

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?

Names a specific verb and resource (list dependents of a GitHub credential) and enumerates both dependent classes: clusters whose GitOps repository uses the credential and Applications built from granted repositories. That scope statement lets an agent distinguish it from get_github_credential_activity, verify_github_credential, and plan_github_credential_replacement without opening any schema.

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?

"Use this before planning a credential replacement or deletion" gives an explicit trigger condition tied to the delete_credential / replace_github_credential / plan_github_credential_replacement siblings. It stops short of naming those alternatives or stating when not to use it (e.g. for activity history), so it is clear but not fully routing.

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.