Upload Markdown

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

Annotations already declare non-read-only and non-destructive, but the description does not add behavioral details such as overwrite behavior, permission requirements, or effect on repository (e.g., creates a commit). The minimal description adds little beyond 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 single sentence is concise but too short given the tool's complexity (4 parameters with no schema descriptions). It under-specifies and fails to provide adequate 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?

With 4 parameters, no schema descriptions, and no output schema, the description is severely incomplete. It does not explain how to use the tool, what the parameters mean, or what the return value is.

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 0%, so the description must compensate. The description does not mention any parameters (content, filename, file_path, project_id) or explain their roles, leaving the agent without guidance.

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 specifies verb 'Upload' and resource 'markdown file/attachment' with context 'to project'. It is clear but could be more precise about the destination (e.g., repository path) and how it differs from siblings like gitlab_push_files or gitlab_create_or_update_file.

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 on when to use this tool vs alternatives such as gitlab_create_wiki_page or gitlab_push_files. The description lacks any when/when-not or context for selection.

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