Skip to main content
Glama

Create Report Link

aidelly_create_report_link

Create a shareable link to a workspace report, either a fixed snapshot or a live view refreshed on a cadence. aidelly_revoke_report_link disables it. Retry-safe: a repeat call with the same idempotency_key returns the original result.

Input Schema

NameRequiredDescriptionDefault
bodyNoOptional body override for endpoints with sparse parameter schemas.
modeYessnapshot for static link, live for auto-updatingsnapshot
queryNoOptional query overrides for endpoints with sparse parameter schemas.
cadenceNoRequired for live mode; update frequency
brand_idNo
passwordNoOptional password to protect the share link
report_idYesUUID of the report to share
expires_atNoOptional expiration timestamp in ISO 8601 format
template_idNoOptional report template to use for rendering
workspace_idNoWorkspace to operate in: the `id` of a workspace returned by aidelly_list_workspaces. Optional for read operations; required when creating content.
idempotency_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / idempotency_key / example
      Added value: +"order-123:create-post:v1"
    • addedInput schema / properties / idempotency_key / maxLength
      Added value: +255
    • addedInput schema / properties / idempotency_key / minLength
      Added value: +1
    • addedInput schema / properties / idempotency_key / pattern
      Added value: +"^[\\x21-\\x7E]{1,255}$"
  2. Changed1 schema field changed
    • changedInput schema / properties / workspace_id / description
      Previous value: -"Workspace to operate in. Do not ask the user for this UUID — call aidelly_list_workspaces and use the `id` of the matching workspace. Optional for read operations; required when creating content."New value: +"Workspace to operate in: the `id` of a workspace returned by aidelly_list_workspaces. Optional for read operations; required when creating content."
  3. Changed1 schema field changed
    • addedInput schema / properties / workspace_id / description
      Added value: +"Workspace to operate in. Do not ask the user for this UUID — call aidelly_list_workspaces and use the `id` of the matching workspace. Optional for read operations; required when creating content."
  4. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnly=false, destructive=false, openWorld=true), and the description adds real value on top: the retry-safe behavior tied to idempotency_key and the mode-dependent refresh semantics. It does not describe the returned artifact, but it meaningfully supplements the annotations rather than repeating them.

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 tight sentences, each earning its place: purpose and modes first, the revoke alternative second, retry semantics last. No filler or redundancy.

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 an 11-parameter, nested-object, no-output-schema tool, the description covers purpose, mode selection, revocation path, and idempotency. It omits what the call returns (presumably the link URL), which would help since no output schema exists.

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 coverage is 82%, so the schema already documents nearly every parameter (mode, cadence, password, expires_at, workspace_id). The description echoes the mode/cadence relationship without adding format or syntax detail beyond what the schema provides; 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 ('Create') and resource ('shareable link to a workspace report') and clarifies the two modes (snapshot vs live). It distinguishes itself from link-creating siblings (create_short_link, create_client_review_link) by resource scope, though it never names them explicitly.

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?

Gives clear usage context: the snapshot-vs-live choice is explained, and it names aidelly_revoke_report_link as the tool that disables the link. It does not, however, tell the agent when to prefer this over the other link-creation siblings.

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.