setup_github_auth

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

With no annotations provided, the description carries full burden and discloses key behavioral traits: it uses 'GitHub's secure device flow - no passwords needed!' which explains the authentication method and security aspect. However, it doesn't mention potential side effects like token storage or error handling.

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?

The description is front-loaded with the core purpose, followed by technical details and usage examples. Every sentence adds value: the first states the action, the second explains the method, and the third provides clear usage triggers without redundancy.

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 0-parameter authentication setup tool with no annotations or output schema, the description is mostly complete—it covers purpose, method, and usage context. However, it lacks details on what happens after setup (e.g., token persistence, scope of access) which would be helpful given the complexity of auth flows.

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 has 0 parameters with 100% schema description coverage, so the baseline is 4. The description adds context about the authentication method ('device flow') and use cases, which provides semantic value beyond the empty schema.

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 clearly states the specific action ('Set up GitHub authentication') and resource ('to access all DollhouseMCP features'), distinguishing it from sibling tools like check_github_auth and clear_github_auth by focusing on initial setup rather than verification or removal.

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?

It explicitly states when to use this tool: 'when users say things like 'connect to GitHub', 'set up GitHub', 'I have a GitHub account now', or when they try to submit content without authentication.' This provides clear triggers and distinguishes it from alternatives like check_github_auth for verification.

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