github_repos_create_deploy_key

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

With no annotations provided, the description bears full responsibility for behavioral disclosure. It only states 'Create a deploy key' without describing side effects (e.g., adding the key to the repository), authentication requirements, idempotency, or limitations. This is minimal transparency.

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 a single, concise sentence that directly states the function. It is well-structured and front-loaded, but lacks supporting details that would make it more helpful. Still, it earns its place without unnecessary verbosity.

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?

Given the tool involves three parameters including a nested body object with no output schema, the description is too minimal. It does not explain what the body should contain (e.g., key, title, read_only), the scope (repo-specific), or any return value. The description leaves significant gaps for an agent to understand how to invoke the tool correctly.

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 100%, so baseline is 3. However, the schema descriptions are basic ('owner', 'repo', 'Request body (JSON object)'), and the tool description adds no further meaning. The body parameter's required fields (e.g., 'key', 'title') are not hinted at, so the description provides minimal added value beyond the 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 action ('Create') and the resource ('a deploy key'). Among sibling tools like github_repos_get_deploy_key, github_repos_list_deploy_keys, and github_repos_delete_deploy_key, this tool is distinct and its purpose is immediately understood.

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?

No guidance is provided on when to use this tool versus alternatives, such as prerequisites, required permissions, or scenarios where other deploy key tools (e.g., listing or deleting) would be more appropriate. The description lacks any usage context.

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