Skip to main content
Glama

Plan GitHub credential replacement

plan_github_credential_replacement
Read-only

Build the replacement plan for swapping a deprecated GitHub OAuth credential to a GitHub App credential: which GitOps usages are eligible, which are blocked and why, and whether a repository sync is required first. Planning only - nothing changes until replace_github_credential applies the plan. 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>",
      "target_credential_id": "<target_credential_id>"
    },
    "name": "plan_github_credential_replacement"
  }
}

Input Schema

NameRequiredDescriptionDefault
credential_idYesUUID of the source (deprecated) GitHub credential.
usage_resource_idsNoOptional subset of usage resource UUIDs to plan for; omit to plan every usage.
target_credential_idYesUUID of the target GitHub App credential.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description reinforces this ("Read-only", "nothing changes") while adding genuinely new information: the plan enumerates eligible vs. blocked usages and flags whether a repository sync is required first. It stops short of saying whether the resulting plan is a handle that must be passed to replace_github_credential or expires.

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?

Two sentences, front-loaded with the action and the transformation, followed by the scope/eligibility detail and the read-only boundary. No filler or restatement of the title.

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?

With no output schema, the description usefully characterizes the plan's return content (eligibility, blocked reasons, sync requirement) and the safety profile. What is missing is the handoff mechanics — whether the plan is a token/identifier to feed into replace_github_credential and whether it has a validity window.

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?

Schema description coverage is 100%, so credential_id, target_credential_id, and usage_resource_ids are already fully documented, including the "omit to plan every usage" default. The description's mention of "which GitOps usages are eligible" loosely echoes usage_resource_ids but adds no new syntax, constraints, or UUID-source guidance beyond the schema.

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 names a specific verb and resource ("Build the replacement plan") plus the exact transformation (deprecated GitHub OAuth credential -> GitHub App credential), and enumerates the plan's contents (eligible usages, blocked usages with reasons, sync prerequisite). This clearly separates it from the sibling replace_github_credential, which applies rather than plans.

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 gives an explicit when-to-use framing and an explicit boundary: "Planning only - nothing changes until replace_github_credential applies the plan," which routes the agent to the correct follow-up tool. It does not, however, mention when to reach for adjacent read tools like get_github_credential_usages or verify_github_credential instead of planning.

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.