Skip to main content
Glama

Start a document

new_document
Read-only

Create an empty document, optionally with metadata such as title, authors, language and description.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "new_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
metadataNoPublication metadata: title, description, language, authors[{name, affiliation}], subjects[].

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior1/5

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

The description says 'Create an empty document', a state-changing operation, while annotations declare readOnlyHint=true and idempotentHint=false. The description adds no behavioral context such as whether the new document replaces or coexists with existing ones, where it is stored, or what identifier is returned for subsequent block operations.

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?

One front-loaded sentence with the core action first and the optional qualifier second; nothing is padded. The 'such as' field list is slightly redundant against the schema but does not bloat the text.

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

Completeness3/5

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

For a single-optional-param creator tool the description is adequate on inputs, but there is no output schema and the description never states what the call returns, which matters because the agent presumably needs a document identifier to then use add_block. It is also silent on persistence and on the interaction with the readOnly annotation.

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?

There is a single optional parameter with 100% schema coverage; the nested schema already enumerates title, description, language, authors and subjects. The description's list ('title, authors, language and description') largely restates the schema rather than adding format, default, or validation meaning.

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?

The description gives a specific verb and resource ('Create an empty document') and clarifies the optional metadata dimension, which distinguishes it from the metadata-editing sibling set_metadata. It never explicitly contrasts itself with import_json/import_markdown or duplicate_block, so sibling differentiation is only implicit.

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?

Usage is only implied: an agent can infer this is the starting point before add_block, with set_metadata used for later edits. There is no explicit statement of when to choose this over importing an existing document, no prerequisites, and no note on what happens to the current document.

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