Skip to main content
Glama

Add a block

add_block
Read-only

Insert a block. Omit index to append. Omit data to use the default content for the type, then call update_block to fill it in.

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": {
      "document": "<document>",
      "type": "<type>"
    },
    "name": "add_block"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataNoBlock data; defaults to the type's default.
typeYesA type from list_blocks.
indexNo
documentYesThe Publisle document: an object with schemaVersion and blocks, as returned by the other tools.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior2/5

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

The description states an insert/mutation ("Insert a block") while annotations declare readOnlyHint=true. This is likely reconcilable — the document is passed in as an argument, so readOnly may describe server state rather than the returned document — but the description never clarifies that distinction, leaving the agent to guess whether calling it is a safe no-op. It also omits index-bounds behavior, ordering effects on existing blocks, and what happens on an invalid type.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the verb, then the two optional-parameter rules, then the follow-up call. No redundant restatement of the title or the obvious.

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 4-parameter tool with a nested document object and no output schema, the description should say what comes back — presumably the modified document that must be passed to update_block — but it does not. The insert mechanics are covered adequately; the return contract and the readOnly/mutation question are not.

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 75% and `index` carries no schema description, yet the description supplies exactly that missing meaning: omitting index appends. It also explains that an omitted `data` falls back to the type default and must later be filled via update_block, which is real semantic value beyond the schema text.

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?

The description opens with a specific verb+resource ("Insert a block") and immediately separates this tool from the update_block sibling by explaining that update_block is the follow-up for filling in content. An agent can tell what this does and what it does not do without inspecting the schema.

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?

It gives concrete when-to guidance on parameter combinations (omit `index` to append; omit `data` to accept the type default) and names the follow-up call (update_block) needed after a default insert. It does not state when to prefer a different insertion tool such as move_block or duplicate_block, nor does it say to call list_blocks to discover valid types (that hint lives only in the schema).

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