Github Set Project Field

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

Annotations already convey idempotence and non-destructiveness; the description adds real behavioral context by disclosing that an issue not on the board is added first, which is a meaningful side effect. It does not cover auth, rate limits, or exact return behavior, but the important mutation behavior is disclosed and consistent with the annotations.

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 compact and front-loaded: the core capability is stated in the first sentence, the important side effect in the second, and the workflow reference in a single short line. Every sentence earns its place with no filler.

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 key side effect and skill reference are included, and an output schema exists, so return values are covered. However, the low parameter coverage and lack of alternative-tool guidance leave gaps for an agent deciding between this and related project-board tools.

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?

With only 29% schema description coverage, the description needed to compensate, but it only clarifies field and option. The five remaining parameters (project_owner, project_number, repo_owner, repo_name, issue_number) are left without explanation in either the schema or the description, so an agent must infer their meaning.

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 states a specific action: 'Sets a single-select field on an issue's card', with the distinguishing detail that field and option are referenced by name rather than node IDs. It is clearly set apart from generic project operations, though it does not explicitly name a sibling tool.

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 implies when to use the tool: when setting a single-select field and when the issue may need to be added to the board first. However, it gives no explicit 'use this instead of X' guidance or exclusions relative to siblings like github_add_to_project or github_get_project_fields. The reference to github_get_skill('project-boards') is a useful workflow pointer but not a usage/exclusion rule.

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