Skip to main content
Glama

Create Doc

create_doc

Create a Doc in the specified accessible project with a title and optional Markdown body. figmaDesigns adds native design embeds, never attachments. Other project members can read it. This does not register the Doc in the Figma plugin page list or add a Figma backlink. Preserve requestId on retries.

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": {
      "requestId": "<requestId>",
      "projectId": "<projectId>",
      "title": "<title>"
    },
    "name": "create_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYesDoc title requested by the user.
contentNoInitial Doc body as Markdown, at most 20,000 characters.
folderIdNoOptional existing destination folder ID. Must be accessible within the target project or task.
projectIdYesExisting accessible project ID returned by list_projects.
requestIdYesA unique UUID for this intended action. Reuse it unchanged when retrying the same action.
figmaDesignsNoSelected Figma designs to embed automatically; tasks also add them to Resources. Use content for Markdown, not legacy description. Ask for the design link if unavailable. Does not write back into Figma.

Output Schema

NameRequiredDescriptionDefault
docYes
figmaNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / figmaDesigns
      Added value: +{
      +  "description": "Selected Figma designs to embed automatically; tasks also add them to Resources. Use content for Markdown, not legacy description. Ask for the design link if unavailable. Does not write back into Figma.",
      +  "items": {
      +    "properties": {
      +      "name": {
      +        "description": "Design name supplied by Figma or the user.",
      +        "maxLength": 500,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "url": {
      +        "description": "Actual Figma design/file URL for the selected frame, section or page, including node-id. Never invent it.",
      +        "format": "uri",
      +        "maxLength": 2048,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "url"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 20,
      +  "minItems": 1,
      +  "type": "array"
      +}
    • addedInput schema / properties / folderId
      Added value: +{
      +  "description": "Optional existing destination folder ID. Must be accessible within the target project or task.",
      +  "maxLength": 100,
      +  "minLength": 1,
      +  "pattern": "^[A-Za-z0-9_-]+$",
      +  "type": "string"
      +}
    • addedOutput schema / properties / figma
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "backlinkCreated": {
      +      "const": false,
      +      "type": "boolean"
      +    },
      +    "designs": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "name": {
      +            "description": "Design name supplied by Figma or the user.",
      +            "maxLength": 500,
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "url": {
      +            "description": "Actual Figma design/file URL for the selected frame, section or page, including node-id. Never invent it.",
      +            "format": "uri",
      +            "maxLength": 2048,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "url"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "docPageListingUpdated": {
      +      "const": false,
      +      "type": "boolean"
      +    },
      +    "pendingResources": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "name": {
      +            "description": "Design name supplied by Figma or the user.",
      +            "maxLength": 500,
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "url": {
      +            "description": "Actual Figma design/file URL for the selected frame, section or page, including node-id. Never invent it.",
      +            "format": "uri",
      +            "maxLength": 2048,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "url"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "resources": {
      +      "enum": [
      +        "linked",
      +        "pending",
      +        "not_applicable"
      +      ],
      +      "type": "string"
      +    },
      +    "warning": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "designs",
      +    "resources",
      +    "pendingResources",
      +    "backlinkCreated"
      +  ],
      +  "type": "object"
      +}
  2. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare a non-read-only, non-idempotent, non-destructive write. The description adds real behavior beyond that: visibility ("Other project members can read it"), side-effect boundaries (no plugin page listing, no Figma backlink), the embed-not-attachment semantics of figmaDesigns, and the retry contract for requestId. It stops short of noting failure modes such as permission or validation errors.

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 compact sentences, with the core action front-loaded and each subsequent sentence carrying a distinct caveat (visibility, non-registration, retry). The final fragment "Preserve requestId on retries" is terse but earns its place; nothing is redundant padding.

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?

For a six-parameter write tool with an output schema and full annotation coverage, the description supplies the key givens: visibility, side-effect scope, and idempotency expectations for retries. Minor gaps remain around what happens on duplicate titles or invalid project/folder access, but nothing essential for a correct call is missing.

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 100%, so the schema already documents every parameter, setting the baseline at 3. The description adds meaningful nuance for figmaDesigns ("native design embeds, never attachments") and reinforces requestId reuse, but says nothing extra about content, folderId, or projectId beyond what the schema states.

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 Doc") plus scope ("in the specified accessible project") and inputs (title, optional Markdown body). It does not name a sibling such as update_doc or edit_doc_content, so the 'create vs. later edit' distinction must be inferred, but the purpose itself is unambiguous.

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 description implies when this applies (new Doc in an accessible project with a title) and carves out what it does not do (no plugin page-list registration, no Figma backlink), which is useful when-not context. However, it never points to alternatives like update_doc or edit_doc_content for modifying an existing Doc, so routing guidance is only 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.