Skip to main content
Glama

create document

create_studio_document
DestructiveIdempotent

Create a document in this document home and season scope. This returns its id; it does not change the workshop subject. Use workspace_id from the authorized Film, Series or GenAds directory. Reuse request_key only for the same exact request.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "title": "<title>",
      "body": "<body>",
      "workspace_id": "<workspace_id>",
      "request_key": "<request_key>"
    },
    "name": "create_studio_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesInitial document text
titleYesDocument title
folder_idNo
season_idNo
request_keyYes
workspace_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

The description adds value beyond the annotations by stating the return payload ("This returns its id") and by spelling out the idempotency contract in operational terms ("Reuse request_key only for the same exact request"), which sharpens the idempotentHint flag. However, annotations declare destructiveHint=true for what is nominally a create operation, and the description neither explains nor reconciles that risk profile, nor does it mention permissions or what happens to an existing document at the same location.

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?

Four short sentences, front-loaded with the action and followed by return behavior, scope caveat, and parameter rules. Every sentence carries information; only the slightly vague phrasing "in this document home and season scope" costs a point.

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?

An output schema exists, so return values need not be described in depth, and the annotations cover safety flags. What remains missing for a 6-parameter mutation tool is the meaning of folder_id and season_id and any note on required permissions or placement conflicts, leaving the definition adequate but not complete.

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 description coverage is only 33% — title and body are documented in the schema while folder_id, season_id, workspace_id and request_key are not. The description compensates for workspace_id (source directory) and request_key (idempotency semantics), and gestures at season_id via "season scope," but folder_id is entirely unexplained by either schema or description.

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 leads with a specific verb+resource ("Create a document") and constrains it to the document home and season scope, and it explicitly notes that it "does not change the workshop subject," which separates it from the save_workshop_document / save_series_document family. It never names the closest sibling (native.create_document or create_studio_document_folder), so the agent must infer which document-creation entry point applies.

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?

There is real guidance on the workspace_id argument ("use workspace_id from the authorized Film, Series or GenAds directory") and on request_key reuse, but no explicit statement of when to prefer this tool over native.create_document, save_workshop_document, or save_series_document despite those siblings being present. The exclusion ("does not change the workshop subject") hints at an alternative without naming it.

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