Skip to main content
Glama

share_api_endpoint

Idempotent

Create an endpoint's shareable link and return it. With no other arguments the link stays restricted: workspace members can open it (they sign in), which is enough for a PR or an internal message. Only when the user asks to share it outside the workspace: set link_access to viewer (anyone with the link can read) or commenter (Team plan; commenting asks for sign-in), or invite people by email (they get an email and sign in with that address). restricted turns the public link off; the URL stays the same. The page is read-only and always hides credentials and secrets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoRoute path as written in the code, e.g. /v1/charges/:id or /v1/charges/{id}.
inviteNoPeople to invite by email (at most 10). Each gets an email.
methodNoHTTP method of the route, e.g. POST. Use with path instead of endpoint_id.
endpoint_idNoId of the endpoint. Alternative to method + path.
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. Added

TDQS

A4.5/5.0
Behavior5/5

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

Adds substantial context beyond annotations: the shared page is read-only and always hides credentials and secrets, `restricted` keeps the URL unchanged, `commenter` requires the Team plan, and invites trigger emails with sign-in. These are real behavioral facts the annotations (readOnly/idempotent/openWorld) do not convey.

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-loads the core action and groups access-level behavior logically. It is somewhat long and the opening sentence is slightly redundant with the title, but every clause carries useful routing information.

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?

With annotations covering safety and no output schema required, the description covers the creation flow, access modes, and the returned link adequately. It could mention idempotency/upsert behavior on repeat shares, but nothing critical 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 meaningfully enriches `link_access`: what viewer/commenter grant, the plan requirement, and the sign-in nuance. It adds semantic value over the raw enum.

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 ('Create an endpoint's shareable link and return it'), and the return behavior is explicit. It is clearly distinguishable from sibling get_api_share_link, which reads rather than creates.

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 strong when-to-use guidance, contrasting the default restricted link (PRs/internal messages) against external sharing via `viewer`, `commenter`, or `invite`. It does not name the sibling get_api_share_link or say when to prefer it, so it falls short of explicit alternatives.

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.