postmd_create_document_from_file

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It adds important context that the file is read from the machine running the MCP server and that this is intended for large files. However, it does not disclose side effects, authentication needs, or what the tool returns after creating the document.

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 one sentence with no filler. It front-loads the key behavioral distinction and use case, making it easy for an agent to quickly grasp when to invoke this tool.

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?

The description provides the critical server-local file context and the large-file use case, which is helpful. However, it relies on the sibling tool for the actual meaning of 'same as postmd_create_document,' and with no output schema or annotations, it leaves return behavior and side effects unexplained.

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 100% parameter coverage with detailed descriptions for all 7 parameters, so the schema already carries the semantic load. The description adds little beyond the motivation for using filePath instead of a pasted body, which does not significantly enhance parameter understanding.

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 identifies this as the file-based variant of postmd_create_document and specifies that it reads Markdown from filePath on the server machine. It distinguishes itself from the sibling tool by targeting large files instead of pasted bodies, though it does not fully describe the creation action on its own.

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 explicitly says to use this tool 'for large files instead of pasting the body,' giving clear context for when it is preferred over the sibling postmd_create_document. It also implies the file must be present on the MCP server, but it does not explicitly state when not to use it.

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