Skip to main content
Glama

Flat overview

wg_overview
Read-onlyIdempotent

Retrieve the connected flat’s manifest—flat details, member names, colors, and your member ID—so you can resolve member names to IDs before calling other tools.

Instructions

Returns the manifest of the connected flat: wg (id, name, shareCode, createdAt), members (id, name, color) and currentMember (your memberId and name). Call it at the start of a task to resolve member names to the member ids that all other tools take. For balances, spending and open items use dashboard_get; to list the other flats of the account use wg_list. 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": "wg_overview"
  }
}

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. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Adds permission context beyond the annotations ('any member may call it') and discloses the returned payload shape in field-level detail, which annotations do not carry. The 'Read-only' restatement is redundant with readOnlyHint=true, and nothing is said about behavior for missing/invalid wgCode, so it falls short of a 5.

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?

Three tight sentences: return contents first, then the call timing/use case, then sibling routing. No filler and each clause carries information the agent needs before invoking.

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 a single optional parameter, full schema coverage and no output schema, the description supplies the missing return-value detail itself (the wg/members/currentMember fields) plus permission and read-only facts. Nothing an agent needs in order to call it correctly 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%: the wgCode property already documents the pattern, its meaning ('Share code of the flat, code from wg_list') and the omission rule for single-flat accounts. The description adds no parameter-level detail, so the 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?

States a specific verb and resource ('Returns the manifest of the connected flat') and enumerates exactly what comes back: wg, members, currentMember. That makes it immediately distinguishable from dashboard_get (metrics) and wg_list (flat enumeration), which the description also names.

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 call condition ('Call it at the start of a task to resolve member names to the member ids that all other tools take') and routes two adjacent needs elsewhere: dashboard_get for balances/spending/open items and wg_list for the account's other flats. Both the when and the when-not are covered.

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