Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Share board

share_board
DestructiveIdempotent

Create or update the shareable link for a board, optionally changing its expiry, download restriction, password, or whether the page accepts uploads. Returns a URL that anyone can open. Exposure: anyone with the link can view the board and its assets without signing in. enable_uploads is the route for FILES THAT CANNOT BE OBTAINED ANY OTHER WAY: a person who opens the returned URL can drop files on it, and they then show up in list_assets on that board. This is the LAST of three upload routes and the only one that needs a live human. A file at a URL Playbook can fetch goes through upload_from_url(s). Bytes the caller HOLDS — generated locally, returned as base64, or on disk — go through create_upload_url when the caller can make HTTP requests. This route is for when both are impossible: no reachable URL and no way to make a request.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tokenYesBoard token
passwordNoPassword-protect the link; empty string clears it
organizationNoWorkspace slug, as returned by list_organizations. Omit it when the account has a single workspace — it is then resolved from your token. Pass it only when the account has several, or when you mean a workspace other than the obvious one.
enable_uploadsNoLet anyone holding the link add files to the board without signing in. It has two consequences. There is NO upload-only mode — such a link still shows the board's contents to whoever opens it. And this endpoint returns the board's EXISTING link when it already has one, so turning uploads on grants upload rights to everyone who was already given that URL for viewing; share a fresh board instead if that matters. Requires a plan with shared-link customization, otherwise the call fails with 403. Pair it with `password` and `expiration_date` when the link leaves a trusted group.
expiration_dateNoISO 8601 expiry; empty string clears an existing expiry
disable_downloadsNoPrevent downloads from the shared page

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / context
      Removed value: -{
-  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
-  "type": "string"
-}
    • changedInput schema / properties / enable_uploads / description
      Previous value: -"Let anyone holding the link add files to the board without signing in. Two things to tell the user before setting it. There is NO upload-only mode — such a link still shows the board's contents to whoever opens it. And this endpoint returns the board's EXISTING link when it already has one, so turning uploads on grants upload rights to everyone who was already given that URL for viewing; share a fresh board instead if that matters. Requires a plan with shared-link customization, otherwise the call fails with 403. Pair it with `password` and `expiration_date` when the link leaves a trusted group."New value: +"Let anyone holding the link add files to the board without signing in. It has two consequences. There is NO upload-only mode — such a link still shows the board's contents to whoever opens it. And this endpoint returns the board's EXISTING link when it already has one, so turning uploads on grants upload rights to everyone who was already given that URL for viewing; share a fresh board instead if that matters. Requires a plan with shared-link customization, otherwise the call fails with 403. Pair it with `password` and `expiration_date` when the link leaves a trusted group."
    • changedInput schema / required
      Previous value: -[
-  "token",
-  "context"
-]New value: +[
+  "token"
+]
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations (destructive, openWorld, idempotent, not read-only) are supplemented with concrete behavioral consequences: anyone with the link can view without signing in, there is NO upload-only mode, the endpoint returns the EXISTING link so enabling uploads retroactively grants rights to prior viewers, and a plan without shared-link customization fails with 403. None of this is inferable from the annotations and it does not contradict them.

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?

Purpose and return value are front-loaded in the first two sentences, then routing guidance. It is longer than most definitions and leans on ALL-CAPS emphasis plus some restatement of schema text, but nearly every sentence carries decision-relevant information.

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 mutation tool with no output schema, the description supplies what an agent needs: the return value ('a URL that anyone can open'), the security exposure, the failure mode (403 without the right plan), and the interaction with the existing link. Nothing material to calling it correctly is 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 description coverage is 100%, so the baseline is 3, but the description adds genuine meaning beyond the schema: the exposure model of the returned URL, the recommendation to pair `password` with `expiration_date`, and the clarification that `enable_uploads` is the human-in-the-loop route feeding `list_assets`. Much of the `enable_uploads` caveat is duplicated in the schema text, which keeps this from a 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?

The first sentence states a specific verb and resource ('Create or update the shareable link for a board') and enumerates the configurable axes (expiry, download restriction, password, uploads). It also positively distinguishes itself from the sibling upload routes by name, so an agent can select it without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explicitly positions itself as 'the LAST of three upload routes' and gives the exact selection conditions for the alternatives: 'A file at a URL Playbook can fetch goes through upload_from_url(s)' and 'Bytes the caller HOLDS ... go through create_upload_url'. It also gives a conditional-use rule for `organization` and advises pairing `password`/`expiration_date` when the link leaves a trusted group.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Playbook toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources