netintel_github_intel

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

With no annotations, the description carries the full behavioral burden. It usefully enumerates what is computed (maintenance score, activity, license), which implies an analysis/read operation rather than a mutation, but it never states that the call is read-only, whether a GitHub token or rate limit applies, or how stale the activity data might be.

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?

Two compact clauses with no filler; the purpose and return contents are front-loaded and the format requirement follows. Every fragment earns its place.

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 one-parameter read tool with no output schema, the description covers the essentials: what is analyzed, what comes back, and the input format. The only real omission is the safety/auth profile that annotations would normally supply.

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?

Schema description coverage is 0%, so the schema alone leaves the single parameter undocumented. The description compensates by specifying the expected 'owner/repo' format, which is exactly the missing semantic detail for this parameter.

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?

States a specific verb (Analyze) plus resource (GitHub repo) and enumerates the returned metrics (stars, forks, activity, license, open issues, maintenance score), so the agent knows exactly what it gets. It does not explicitly differentiate from near-siblings like netintel_npm_intel or netintel_tech_fingerprint, though the resource name makes the distinction fairly obvious.

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?

The description gives no when-to-use context, no prerequisites, and names no alternative tool. The only guidance present is the input format instruction, which is parameter-level rather than usage-level.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.