Skip to main content
Glama

Create a Markdown Document

create_article
Idempotent

Create a durable Markdown Document with initial content in an accessible workspace. Omit the workspace selector when the user has only one workspace, or pass workspaceName when they chose one by name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
contentYes
contextYesDescribe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.
folderIdNo
commandIdYesGlobally unique UUID for this logical document creation. Generate it once and reuse the exact value if the tool call is retried.
workspaceIdNoInternal workspace identifier from list_workspaces. Required when choosing between workspaces with duplicate names; otherwise use workspaceName. Omit only when list_workspaces returns exactly one workspace.
collaborativeNo
workspaceNameNoHuman-visible workspace name. Prefer this over asking the user for an internal workspace identifier.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleYes
contentYes
articleIdYes
editorUrlYes
contentHashYes
workspaceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Describe the user's underlying goal in one sentence. Do not include private document content, credentials, or personal information.",
      +  "type": "string"
      +}
    • changedInput schema / properties / workspaceId / description
      Previous value: -"Internal workspace identifier when already available. Omit it when the user referred to a workspace by name or has only one workspace."New value: +"Internal workspace identifier from list_workspaces. Required when choosing between workspaces with duplicate names; otherwise use workspaceName. Omit only when list_workspaces returns exactly one workspace."
    • changedInput schema / required
      Previous value: -[
      -  "commandId",
      -  "title",
      -  "content"
      -]New value: +[
      +  "commandId",
      +  "title",
      +  "content",
      +  "context"
      +]
  2. Changed2 schema fields changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Globally unique UUID for this logical document creation. Generate it once and reuse the exact value if the tool call is retried.",
      +  "format": "uuid",
      +  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "title",
      -  "content"
      -]New value: +[
      +  "commandId",
      +  "title",
      +  "content"
      +]
  3. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, so the safety/idempotency profile is covered. The description adds 'durable' and 'initial content', which is light context, but omits any auth/permission requirement or what happens to pre-existing content. With annotation coverage already strong, this is a modest addition.

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?

Two sentences, front-loaded with the core action before the workspace-selection branch, with no filler. It is efficient, though the second sentence is dense and could be scannable rather than run-on.

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?

An output schema exists, so return values need not be explained, and annotations carry the mutation/idempotency profile. For a create tool with 8 params, the definition is broadly sufficient, though it never addresses permissions or the collaborative flag.

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 50%, so half the parameters (title, content, folderId, collaborative) are undocumented in both places. The description reinforces the workspace selection rule, but the schema's own workspaceId/workspaceName descriptions already cover that, so the marginal value is small. 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 plus resource ('Create a Markdown Document') with the scope qualifier 'in an accessible workspace' and the notion of 'initial content'. This is clearly distinct from siblings like edit_article and save_article_content, but it never explicitly names or contrasts an alternative, so it stops short of a 5.

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 stated guidance ('Omit the workspace selector when the user has only one workspace, or pass workspaceName when they chose one by name') is really parameter-selection advice rather than when-to-use-this-tool-versus-a-sibling guidance. There is no statement about when to create versus edit or convert a document, which leafs usage implied.

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