Skip to main content
Glama

Describe a Populi API route

populi_describe_api
Read-onlyIdempotent

Retrieve full reference details for a Populi API route, including parameters, filters, required roles, and docs link, by passing a route ID or method and path.

Instructions

Full reference for one route: path placeholders, required/optional parameters with types, expandable properties, filter conditions, required Populi roles, and a link to the docs. Pass a route id from populi_search_api, or a concrete method and path.

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": "populi_describe_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoRoute id such as people.show
pathNoA route path such as /people/123 or /people/(person)
methodNoWith `path`, to look a route up by URL

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.4.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv0.2.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and closed-world, so the safety profile is covered; the description adds value by disclosing what the response contains, including doc links and role requirements. It does not say what happens with an unknown route id or an ambiguous path, which is a minor remaining gap for a metadata lookup.

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 sentences, no filler: the payload contents come first, then the two valid input modes. Every clause carries information an agent needs to select and call the tool.

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?

For a three-optional-parameter read-only lookup with no output schema, enumerating the returned reference contents makes the definition self-sufficient. Only the failure behavior for unknown or non-matching routes is unaddressed.

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; the description earns an extra point by clarifying that `id` and the `method`+`path` pair are alternative lookup modes rather than independent knobs. It still leaves the id-uniqueness and path-matching rules to the schema.

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?

"Full reference for one route" is a precise verb+resource, and the enumeration that follows (path placeholders, typed params, expandable properties, filters, required roles, docs link) defines the payload concretely. Naming populi_search_api as the source of route ids implicitly separates lookup-by-search from lookup-by-id here.

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 states two concrete invocation paths: a route id from populi_search_api, or a method+path pair, which tells the agent exactly what input to gather first. It stops short of explicit when-not guidance (e.g. that it does not execute the route, that populi_get should be used to call it), which an agent must infer.

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