ping
Verifies that the MCP server is reachable, helping clients confirm connectivity before using GitHub operations.
Instructions
Check that the server is reachable.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Verifies that the MCP server is reachable, helping clients confirm connectivity before using GitHub operations.
Check that the server is reachable.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the behavioral burden. 'Check that the server is reachable' implies a non-destructive read with no side effects, which is the important safety signal, but it says nothing about timeout behavior, whether a failure raises an error or returns false, or what 'reachable' covers (network path vs. application health).
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?
One short sentence with no filler, and the single piece of information an agent needs is front-loaded. Nothing could be removed without losing meaning.
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?
For a zero-parameter probe the description is nearly complete, but with no output schema present either, an agent cannot tell what a successful result looks like (a literal, an empty response, a latency value) or how failure is surfaced. One added clause about the return signal would close the gap.
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?
The tool takes zero parameters, so the baseline is 4. Nothing is missing on the input side and the description needs no parameter explanation.
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 description has a concrete verb ('Check') and a concrete resource ('the server is reachable'), so there is no ambiguity about what the tool does. It loses the top mark only because there is nothing to differentiate it from — no siblings exist — so the one-line scope statement is all that is offered.
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 explicit 'use this when...' guidance, but with zero parameters and no sibling tools, the invocation context is self-evident: call it to verify liveness before or after other work. Adequate by implication rather than by statement.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.