Skip to main content
Glama
Sign In
Plannr MCP Server

Plannr MCP Server

by dragosh29
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

Get household

get_household
Read-onlyIdempotent

Fetch a household by UUID to view its members, groups, portal access, engagement rating, and last portal login.

Instructions

One circle (household) by UUID with its members by name, groups, portal access, engagement rating and last portal login. Uses GET /api/v1/circles/{uuid}.

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": {
      "household_uuid": "<household_uuid>"
    },
    "name": "get_household"
  }
}

Input Schema

NameRequiredDescriptionDefault
household_uuidYesCircle UUID
include_contact_detailsNoInclude members' email addresses and third-party references. Off by default.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and open-world, so the safety profile is covered. The description adds value by disclosing the concrete fields returned (groups, portal access, engagement rating, last portal login) and the backing endpoint, though it says nothing about auth requirements or error behavior.

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?

Two tight sentences: the payload contents are front-loaded, followed by the endpoint reference. No filler or redundancy.

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 no output schema, the description usefully compensates by enumerating the returned fields, and annotations cover the safety profile. It stops short of covering the optional contact-details toggle's effect or failure modes, but is largely sufficient for calling the tool correctly.

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 description coverage is 100% and the UUID pattern plus the include_contact_details default are fully documented in the schema. The description adds no parameter-level meaning beyond that, 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 (get) and resource (one household/circle by UUID) and enumerates exactly what the payload contains: members by name, groups, portal access, engagement rating, and last portal login. This clearly distinguishes it from the sibling list_households and from get_client/get_case.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'One circle (household) by UUID' implies single-record retrieval, so usage is inferable, but there is no explicit when-to-use guidance, no mention of the alternative list_households for bulk access, and no note on when to flip include_contact_details.

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

Deploy Server

Other Tools