Skip to main content
Glama

set_report_sharing

Publish or unpublish a report and control who can reach its share link (/p/:id). visibility: 'public' (anyone with the link), 'registered' (any signed-in user), 'domain' (anyone signed in with a verified email on one of allowed_email_domains — required with 'domain', e.g. ['acme.com']), 'team' (the report's team; the report must already be filed under one), or 'private' (owner + invited people only). To change the domain list, send visibility='domain' again with the full new list. public_permission is what link/anonymous visitors may do: 'none', 'view', 'comment', or 'edit'. To publish a report so anyone can open and comment on it, set visibility='public' and public_permission='comment'; add allow_guest_comments=true so reviewers without a Comma account (clients, stakeholders) can comment too — they appear as guests and cannot sign off. show_approved_only enables staged publishing: view-only audiences see the last revision a reviewer approved (see set_report_signoff) while reviewers keep seeing head. allowed_embed_origins opts the report into embedding on other sites: pass the bare origins allowed to iframe it (e.g. ['https://acme.com']), or [] / null to turn embedding off. The response then carries embed_snippet, the exact markup to paste into the host page; the embed only renders while the report is public, its link permission isn't 'none', and it has no share password. Requires manage permission on the report (owner or admin).

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": {
      "report_id": "<report_id>"
    },
    "name": "set_report_sharing"
  }
}

Input Schema

NameRequiredDescriptionDefault
report_idYesUUID of the report.
visibilityNoWho can reach the report.
public_permissionNoWhat link/anonymous visitors may do.
show_approved_onlyNoStaged publishing: when true, view-only audiences see the last approved revision instead of head.
allow_guest_commentsNoWhen true, anyone with the link can comment and reply without an account (labelled 'guest'; rate-limited; cannot sign off). Only takes effect while visibility='public', public_permission='comment' and no share password is set.
allowed_email_domainsNoEmail domains allowed to view when visibility='domain' (e.g. ['acme.com']). Required with, and only accepted with, visibility='domain'; replaces the existing list.
allowed_embed_originsNoOrigins allowed to iframe this report via /embed/:id. Bare origins only — scheme + host + optional port, no path (https://acme.com, https://blog.acme.com:8443). https is required except for http://localhost and http://127.0.0.1. [] or null turns embedding off.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / allow_guest_comments
      Added value: +{
      +  "description": "When true, anyone with the link can comment and reply without an account (labelled 'guest'; rate-limited; cannot sign off). Only takes effect while visibility='public', public_permission='comment' and no share password is set.",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so: it discloses the required permission level (manage; owner or admin), the replace-not-merge semantics of re-sending visibility='domain', the render preconditions for embeds (public, link permission not 'none', no share password), and that guests cannot sign off. It also names the response field embed_snippet so the agent knows what comes back.

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?

Front-loaded with purpose, and despite being a single dense paragraph nearly every clause carries distinct information needed to configure the enums. Some redundancy with the already-descriptive schema fields and a few over-long parentheticals prevent a 5.

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

Completeness5/5

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

For a 7-parameter mutation tool with no annotations and no output schema, the description covers permissions, enum semantics, parameter interactions, and even the shape of the returned embed snippet. Nothing an agent needs in order to call this correctly appears to be missing.

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 100% so the baseline is 3, but the description adds cross-parameter meaning beyond the schema: the interaction between visibility='public', public_permission='comment' and allow_guest_comments, and the link between show_approved_only and set_report_signoff. Some content (domain-list replacement, embed origin rules) duplicates the schema descriptions, keeping it below 5.

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?

States a specific action ('Publish or unpublish a report and control who can reach its share link') plus the concrete resource path (/p/:id). An agent can distinguish this from sibling setters like set_report_signoff or update_report without reading 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 usage recipes — 'To publish a report so anyone can open and comment on it, set visibility=public and public_permission=comment' — and explains what each visibility mode means, including the constraint that 'team' requires the report to already be filed under a team. It lacks explicit routing away from alternatives (e.g. when to use update_report instead), so it stops short of a 5.

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.