Skip to main content
Glama

Read GitHub status

githubStatus
Read-onlyIdempotent

Read, with no GitHub credential of any kind, one owned project’s recorded GitHub code state, as the Source card on Versions shows it. This is the recorded GitHub source and synchronization state. A null source means “not imported from GitHub”, never “unknown”. state (automatic updates) is disabled, enabled (a push to branch deploys) or paused (Tofu stopped following it; see reason); pending: an update is in flight. lastCommitSha: the last push Tofu took in, live or not. Turning updates on does not depend on the account’s plan (paid). This tool cannot import a repository or turn updates on: turning updates on, and importing a private repository, need the human’s own GitHub grant, which lives in their browser session, and are dashboard operations. It returns no token, installation id, repository id or archive URL.

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": {
      "projectId": "<projectId>"
    },
    "name": "githubStatus"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYes

Output Schema

NameRequiredDescriptionDefault
paidYes
stateYes
branchYes
reasonYes
sourceYes
pendingYes
lastCommitShaYes
rootDirectoryYes
lastDeliveryAtYes
lastDeploymentIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover safety (readOnlyHint, idempotent, non-destructive, closed-world), and the description adds substantive context beyond them: no credential of any kind is required, what a null source means, what each state value implies, and that no token, installation id, repository id or archive URL is returned. The security posture and data-exposure boundary are made explicit.

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 core capability and the credential-free scope are front-loaded, and each sentence carries information. Some field-by-field explanation of state, lastCommitSha and source duplicates what the existing output schema already documents, which is the main waste.

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?

With an output schema present, the description needn't explain return values, yet it goes further by defining null-source and state semantics and enumerating what is deliberately withheld. Combined with the annotations, an agent has everything needed to call this safely and interpret the result.

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?

Only one parameter (projectId) with 0% schema description coverage, so the description must carry the load. It constrains the id to 'one owned project', which adds real meaning, but says nothing about format, where to obtain the id, or what happens for a project the caller doesn't own.

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?

States a specific verb and resource ('Read ... one owned project's recorded GitHub code state') plus the exact surface it mirrors ('the Source card on Versions'). It also rules out adjacent operations (importing a repo, enabling updates), so an agent can separate it from githubSyncDisable and the dashboard flows without opening a 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?

Gives explicit when-not guidance: 'This tool cannot import a repository or turn updates on', and explains that those need the human's browser-session GitHub grant and are dashboard operations. It does not name the sibling (e.g. githubSyncDisable) that handles the disable path, so routing for that action is left to inference.

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.

Resources