Skip to main content
Glama

Create document

create-document

Create a new requirements document. PUBLISHES IMMEDIATELY as version 1 — visible to the whole team and to dotreq sync. The markdown's leading H1 is the document's title (omit it for an untitled document). Markdown may embed ```dotrequirements blocks; malformed blocks reject the creation. Returns a shareable link.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectYesThe project target: its slug (find it with list-projects), e.g. 'acme-checkout'
markdownYesThe document's full markdown content. The leading `# H1` is the document's title. May embed ```dotrequirements blocks

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior5/5

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

Annotations only say readOnly=false and non-idempotent; the description goes far beyond them by disclosing immediate team/dotreq visibility, version-1 semantics, validation behavior (malformed dotrequirements blocks reject creation), title derivation from the leading H1, and the returned shareable link. That is exactly the behavioral context an agent needs before a non-reversible write.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the verb and the most consequential fact (immediate publication). Minor redundancy with the schema on the H1/title rule, but nothing is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description helpfully covers the return value (shareable link), the publication side effects, and the failure mode for malformed blocks. It omits permission/auth requirements for the target project and says nothing about the relationship to the near-identical sibling tool, which is the main remaining gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents both parameters, including the H1-as-title rule and the dotrequirements block support. The description largely restates that, adding only the edge case that an omitted H1 yields an untitled document, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Create a new requirements document') and adds scope details like immediate publication. However, it does not differentiate itself from the very similar sibling 'create-requirement-document', leaving the agent to guess which of the two to call.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The note that the document PUBLISHES IMMEDIATELY as version 1 implies this is the direct-to-live creation path rather than a draft-then-publish flow, which is useful implied guidance. But no alternative is named (e.g. publish-document, edit-document), and no prerequisites or when-not-to-use conditions are given.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources