Skip to main content
Glama

List active invite links

invites_list
Read-onlyIdempotent

Lists active invite links for a flat, newest first, including IDs, expiry, limits, and use counts. Use it to find an invite ID to revoke or verify usage; it never returns the link URL.

Instructions

List the active invite links of the flat, newest first, each with id, createdAt, expiresAt, maxUses, useCount and createdByName. Links that expired, were revoked or reached their use limit are not listed. Use it to find the id for invite_revoke or to see whether a link was used; it never returns the link URL itself (only invite_create does), so a lost link has to be revoked and recreated. Read-only; any member may call it.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "invites_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
wgCodeNoShare code of the flat (code from wg_list). Leave it out when the account belongs to one flat.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnly, idempotent, and non-destructive annotations, the description discloses exclusions (expired, revoked, or maxed-out links are omitted), ordering, returned fields, and the absence of the URL. It also states who may call it, namely any member.

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?

The description is dense but front-loaded, starting with the core purpose and ordering before covering exclusions, use cases, and the URL limitation. Every sentence carries useful selection or invocation context.

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 specifying the returned fields and the active-link filtering rules. For a simple one-parameter read tool with annotations already covering safety, nothing material is missing.

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%, and the optional wgCode parameter is fully documented in the schema, including its format and when to omit it. The description only says 'of the flat' and adds no further parameter semantics beyond the schema, so the baseline score is appropriate.

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 gives a specific verb and resource: it lists active invite links for a flat, newest first, and names the fields returned. It also distinguishes this read operation from invite_create by noting that only invite_create returns the link URL.

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 states when to use the tool: to find the id for invite_revoke or to check whether a link was used. It also explains the alternative for a lost link, which must be revoked and recreated since the URL is unavailable here.

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