postmd_create_documents_from_files

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

With no annotations, the description carries the full burden, and it discloses a critical behavior: the outer resultCode is 200 even when individual files fail, directing the agent to inspect data.succeeded and data.results. It also mentions the API key requirement. This goes well beyond the schema.

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 extremely compact: two sentences convey the core operation, the auth requirement, and the surprising partial-failure behavior. No words are wasted and the most important caveat is front-loaded.

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?

Without annotations or an output schema, the description explains the essential non-obvious behavior (partial failures and where to find per-file results). It could add a bit more about the success response format or when a fully successful call looks like, but it is sufficient for an agent to invoke the tool and interpret the returned data.

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 100%, so each parameter is already documented. The description does not add parameter-level detail beyond what the schema provides, which is acceptable given the high coverage.

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 verb ('Publish'), a specific resource ('.md files'), and the scope ('several in one call / bulk upload'). It also distinguishes itself from the sibling postmd_create_document_from_file, which handles a single 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?

The phrase 'Publish several .md files in one call (bulk upload)' clearly implies the tool is for multi-file publishing, distinguishing it from single-file sibling tools. It also states the required permission (documents:write). It does not explicitly enumerate when not to use it, but the usage context is clear.

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