pbi_write_tmdl_file

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

Without annotations, the description carries the full burden of disclosing behavioral traits. It mentions 'Create or overwrite' but omits details on side effects, such as whether the file is replaced without warning, required permissions, or error handling. The behavior of the 'create' boolean parameter is not explained.

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?

While the single sentence is concise, it is undercoded. It lacks structure and fails to provide necessary details about parameters or usage. Conciseness should not come at the expense of missing critical information.

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's complexity (file write operation with 4 parameters, no annotations, and an output schema not described), the description is completely inadequate. It does not explain the file format (TMDL), the role of the 'create' flag, or what the return value contains.

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 has 0% coverage (no parameter descriptions) and the tool description does not explain any parameters. The agent gets no additional meaning about 'project_path', 'relative_file', 'content', or 'create' beyond their names and types.

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 or overwrite') and the resource ('one TMDL file inside a Power BI Project definition folder'). It distinguishes this tool from siblings like pbi_read_tmdl_file and pbi_list_tmdl_files, making its purpose unambiguous.

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, nor prerequisites or exclusions. The minimal description does not help an agent decide when to invoke this tool or what conditions to check (e.g., file existence, required permissions).

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