Skip to main content
Glama

Upstream.codes

Read GitHub connection

github_read
Read-only

GitHub state for a namespace or repository. what=connection: whether the namespace's GitHub App is connected. repositories: GitHub repositories it can import or sync. sync_status, health, migration: an Upstream repository's GitHub Sync, mirror health and migration state (need repo).

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": {
      "what": "<what>",
      "owner": "<owner>"
    },
    "name": "github_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
repoNoRepository slug.
whatYes
ownerYesUpstream namespace.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety and external-call profile is known. The description adds the repo-dependency of three modes, which is useful behavioral context, but says nothing about permissions required for the GitHub App, failure modes, or the shape of the returned data.

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?

Dense but front-loaded: the general scope comes first, then each mode is defined in a single clause. The telegraphic "what=connection:" style is slightly cryptic and the mode definitions are packed into one sprawling sentence, but no content is wasted.

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

Completeness3/5

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

For a 3-parameter, five-mode read tool with no output schema, the description covers mode semantics and the conditional repo requirement, which is the core need. It stops short of indicating what each mode actually returns (e.g. a boolean flag vs. a list, or the fields of sync_status/health), leaving the agent to discover result shapes by calling.

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 67% and the `what` enum has no per-value descriptions in the schema, so the description is the only place explaining what each of the five modes means (connection, repositories, sync_status, health, migration). owner and repo are already documented in the schema, and the description correctly notes repo is required only for three modes.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

"GitHub state for a namespace or repository" plus a per-value breakdown makes clear this is a read of GitHub App connectivity, importable repositories, and sync/mirror/migration status. The resource is specific and the five modes are enumerated, but the opening sentence is broad ("GitHub state") and the description never states the verb outright, so the exact operation is inferred from the enum.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is one genuine conditional: the sync_status/health/migration modes "need repo", which tells an agent when to supply the optional parameter. Beyond that there is no guidance on when to pick this tool over siblings such as get_repository or list_repositories, and no statement of what it does not cover.

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