GitHub status
github_statusGitHub connection + linked repo status
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | No | Project id (or use session from use_project) |
github_statusGitHub connection + linked repo status
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | No | Project id (or use session from use_project) |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, openWorldHint=true, and destructiveHint=false, so the safety profile is fully covered. The description adds only the scope hint that both connection state and linked-repo state are reported; it says nothing about behavior when no repo is linked, no auth requirements, or what the response looks like.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Five words with zero padding and the subject front-loaded, but it is under-specified rather than concise – there is no wasted text because there is almost no text. Brevity here comes at the cost of usability.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool is genuinely simple (one optional param, read-only, open-world), so a short description is defensible. However, with no output schema, the description is the only place a caller could learn what 'status' returns, and it does not say.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one optional parameter and schema coverage is 100% – the schema itself explains project_id and the session fallback via use_project. The description contributes no additional parameter meaning, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The fragment 'GitHub connection + linked repo status' does identify the resource and that it is a status read, which separates it from the generic get_status. But it is a noun phrase with no verb and no explicit contrast to siblings like github_link_repo, github_sync, or github_pull, so the agent must infer which GitHub tool answers a status question.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to call this versus github_link_repo, github_sync, or get_status, and no stated preconditions (e.g., does it need a linked repo first?). The single schema hint about project_id/session is the only routing help present.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.