Skip to main content
Glama

Create an editable report

create_editable_report
Idempotent

Generate an editable PPTX or DOCX report pack from an existing hosted project. Use get_download_link on the returned artifact ID after the job succeeds.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatYes
waveIdNo
tableIdsNo
projectIdYes
requestIdYesA new UUID for this task, reused only when retrying identical inputs.
templateIdNo
idempotencyKeyYes
workspaceTokenYesSecret workspace capability returned by create_workspace. Treat as a password; never place in a query string.
expectedRevisionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already state readOnlyHint=false, idempotentHint=true, and destructiveHint=false, and the description does not contradict them. It adds useful behavioral context by revealing the operation is asynchronous ('after the job succeeds') and returns an artifact ID that must be passed to get_download_link.

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?

The description is two tight sentences: the first states the core purpose, the second gives the follow-up action. It is front-loaded and contains no filler or redundant restatement of the tool name.

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

Completeness2/5

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

This is a 9-parameter asynchronous tool with no output schema, yet the description only covers purpose and the handoff to get_download_link. Required semantics such as expectedRevision, idempotencyKey, and job/status behavior are missing, so an agent lacks enough context to invoke the tool correctly in edge cases.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 22%, with just requestId and workspaceToken described in the schema. The description adds only implicit meaning for format ('PPTX or DOCX') and project ('existing hosted project'), leaving critical parameters such as expectedRevision, idempotencyKey, tableIds, waveId, and templateId unexplained.

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 names a concrete action: generate an editable PPTX or DOCX report pack from an existing hosted project. The 'editable' qualifier and format list help distinguish it from sibling tools like generate_report_pack. It is specific and not a tautology.

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 provides clear workflow guidance by telling the agent to use get_download_link on the returned artifact ID after the job succeeds. However, it never explicitly says when to prefer this tool over siblings such as generate_report_pack or refresh_report_pack, so the when-to-use guidance is mostly implicit.

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