bb_create_file

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

With no annotations, the description must disclose behavior. It states that it creates a file, allows an optional commit message, and returns the commit id and file path. However, it does not explain what happens if the file already exists (overwrite vs. error) or whether parent directories are created. This is a meaningful gap for a mutation tool.

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 efficient sentences. The core action and parameters are front-loaded, followed by the optional parameter and return value. No wasted words.

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 six-parameter tool with no output schema, the description provides the key return value (commit id and file path) and the default commit message. It is missing conflict/overwrite behavior, which is important for a create operation, but overall the description covers the essential information an agent needs to invoke it.

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 67%, and the schema already explains path, branch, content, and message. The description adds the commit message default value and the return values but does not clarify repoSlug or projectKey, which are undocumented in both schema and description. Overall it adds modest 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 has a specific verb and resource: 'Create a new file' at a path on a branch. It clearly differentiates itself from siblings like bb_update_file and bb_delete_file by stating it creates, not updates or deletes.

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 clearly implies its use case: creating a new file. It does not explicitly name alternatives or exclude existing files, but 'New' in the first sentence provides clear context. No explicit when-not-to-use guidance, but the intent is unambiguous.

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