Skip to main content
Glama

share_api_collection

Idempotent

Share a whole collection: every endpoint in it (including ones added later), with its examples and latest run, read-only and with secrets hidden. Environments are never shown and it can't be exported. Returns the collection's link, which never changes. With no other arguments it stays restricted to the workspace; set link_access or invite people only when the user asks to share it outside the team. get_api_collection returns the link as share once it exists.

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": {
      "collection_id": "<collection_id>"
    },
    "name": "share_api_collection"
  }
}

Input Schema

NameRequiredDescriptionDefault
inviteNoPeople to invite by email (at most 10). Each gets an email.
link_accessNoWho can open it with just the link. Omit to keep the current setting (restricted for a new share).
collection_idYesId from list_api_collections.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / collection_id / description
      Added value: +"Id from list_api_collections."
  2. Added

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare generic hints (non-read-only, idempotent, non-destructive); the description adds substantive traits: content is read-only for recipients, secrets are hidden, environments are never shown, the collection cannot be exported, and the link is stable across calls. That is real behavioral context beyond the structured hints.

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?

Four tight sentences, each with a distinct payload: scope, disclosure rules, return value, and sharing guidance. No redundancy and the primary action is front-loaded.

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?

With 3 parameters, full schema coverage, no output schema, and annotations covering the safety profile, the description fills the remaining gaps: what recipients see, what is withheld, and what the call returns. Nothing needed to invoke 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 coverage is 100%, so the baseline is 3, but the description adds decision-level meaning: link_access and invite should only be used when the user asks for sharing outside the team. It does not restate the enum values or the 10-invite cap, which the schema already carries.

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 verb and resource ('Share a whole collection') and immediately scopes it as covering every endpoint including future ones, which cleanly separates it from the sibling share_api_endpoint. An agent can distinguish the two without opening a 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?

Gives an explicit default ('with no other arguments it stays restricted to the workspace') and a narrow condition for escalation ('set link_access or invite people only when the user asks to share it outside the team'). It also routes the agent to get_api_collection for retrieving the resulting link.

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.