Skip to main content
Glama

Traceable

Create document

traceable_doc_create

Create a document in a project. Start from a template: pass templateId to clone an org/system template (header/footer bands, title page, revision + signature scaffolding come along — discover templates with traceable_workspace_templates); trmContent then authors the body. Without a template, only default header/footer bands are seeded for any segment trmContent does not provide. A controlled document should end up with a Revision Table, a Reference Table, a Glossary (from the template; not writable as TrMD) and ID rows for everything that must be linked: see documentComposition in traceable_capabilities. A test report places its Test Plan with [[test-plan plan=""]], naming a plan that already exists in Project settings. Returns the new documentId and the created rows with their row orders.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDocument name
groupIdNoDocument group UUID (from traceable_workspace_map)
idPrefixNoTraceID prefix (uppercase letters/digits/hyphens, e.g. FR)
projectIdYesThe project UUID (from traceable_workspace_projects)
templateIdNoTemplate document UUID to clone
trmContentNoInitial TrMD content (body only when templateId is set)
documentTypeNoDocument type from the organisation taxonomy
documentNumberNoDocument number (e.g. TD01-003)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With annotations only covering the safety profile (readOnly=false, idempotent=false, destructive=false), the description carries real behavioral detail: exactly what a template clone brings along (header/footer bands, title page, revision + signature scaffolding), what gets seeded when no template is given, what a controlled document should contain, and the [[test-plan]] placement syntax for test reports.

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?

Front-loaded with the core action and every sentence carries non-redundant information. It is dense, however, with long em-dash and parenthetical clauses that make the template-vs-no-template branch harder to scan than it needs to be.

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

Completeness5/5

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

No output schema exists, yet the description states the return value (documentId plus created rows with their row orders), and it covers the template, default-seeding, controlled-document composition, and test-plan placement cases. Nothing an agent needs to invoke it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: it explains that templateId clones an org/system template and that trmContent then authors the body, and that without a template only default bands are seeded. That clarifies the templateId/trmContent interaction the schema only hints at.

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

Purpose5/5

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

Opens with a specific verb+resource+scope: 'Create a document in a project.' An agent can immediately distinguish it from traceable_doc_update_meta, traceable_doc_read, and traceable_doc_delete, and the description names the sibling tools (traceable_workspace_templates, traceable_capabilities) that support it.

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

Usage Guidelines4/5

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

Gives explicit conditional guidance: pass templateId to clone a template, otherwise only default header/footer bands are seeded, and it routes the agent to traceable_workspace_templates for discovery and traceable_capabilities for documentComposition. It does not state when this tool should NOT be used or name a competing creation path, so it falls short of a full 5.

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