Create A Note In The Project

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

The description adds that the tool returns the created object on success (HTTP 201) and lists required parameters. Annotations already indicate it's a write operation. No additional behavioral traits like idempotency or side effects are disclosed.

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 four sentences, efficiently covering purpose, API context, success response, and required parameters. Slight redundancy in the first two sentences but overall well-structured.

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 no output schema, the description provides endpoint, API version, and success response. The parameter 'value' is vaguely described as 'the value for this Bid Board operation,' which could be more specific. Overall adequate for a create tool.

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 input schema covers all three parameters with descriptions, achieving 100% coverage. The description redundantly lists required parameters but adds no new meaning 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 'Create a note in the project' and identifies the target as Bid Board records in Procore. However, slight inconsistency between 'note' and 'Bid Board records' causes minor confusion.

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 explicit guidance on when to use this tool versus alternatives like the v1.0 version or other create tools. The description does not mention use cases or exclusions.

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