Skip to main content
Glama

Get Share Link Settings

get_jit_share
Read-only

Return the share link settings for a Lite server (by id or exact name): the share URL friends can use to start the server, whether it is locked, whether a password is required, any Discord invite shown on the share page, and (only when confirm is true) the password. Works while the server is hibernating too, since these settings persist while it sleeps. Only Lite servers have a share link.

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": {
      "instance": "<instance>"
    },
    "name": "get_jit_share"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmNoSet true to include the share password in plaintext. Only do this when the user explicitly asked to see it.
instanceYesInstance id (preferred) or exact instance name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

readOnlyHint=true already tells the agent this is a safe read, and the description adds real context beyond that: the settings persist while the server sleeps, and the password is only surfaced when confirm is true. It does not discuss any permission or authorization requirements for viewing share settings, which is the main remaining gap.

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?

The purpose and returned fields are front-loaded in the first sentence, and the two follow-up sentences each carry distinct information (hibernation availability, Lite-only restriction). The field enumeration in the opening sentence is long but every listed field is one the agent would otherwise have to guess, since there is no output schema.

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 no output schema, the description compensates by enumerating the returned fields, and it also flags the Lite-only restriction and the hibernation case. An agent has everything needed to decide whether to call it and how to interpret the result.

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 100%, so both parameters are already documented, including the confirm gate and the 'id or exact name' semantics of instance. The description largely restates the schema's confirm behavior ('only when `confirm` is true') without adding new format or edge-case detail, so baseline 3 applies.

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 description opens with a specific verb and resource ('Return the share link settings for a Lite server') and then enumerates exactly which settings are returned: share URL, locked state, password requirement, and Discord invite. It also distinguishes this read tool from the mutating siblings set_jit_share and regenerate_jit_share_url by framing it purely as a retrieval.

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 clear preconditions for use: the target must be a Lite server ('Only Lite servers have a share link') and it works while hibernating, which is non-obvious. It does not explicitly route the agent to set_jit_share or regenerate_jit_share_url when the user wants to change the link instead of read it, so it stops short of full when/when-not guidance.

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.

Resources