Skip to main content
Glama

yeastar_read

Read-onlyIdempotent

Queries read-only Yeastar PBX API endpoints (GET) to retrieve CDRs, reports, live queue, call and conference status, recordings, logs and menu options; rejects any endpoint that modifies data.

Instructions

Chiama qualsiasi endpoint di SOLA LETTURA dell'API Yeastar (GET). Utile per CDR, report, stato live di code/chiamate/conferenze, registrazioni, log, opzioni dei menu. Rifiuta gli endpoint che modificano qualcosa: per quelli usa yeastar_prepare_raw.

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": {
      "endpoint": "<endpoint>"
    },
    "name": "yeastar_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
paramsNoParametri query
endpointYesEndpoint di sola lettura, es. 'queue/agent_status', 'call/query', 'cdr/search', 'system/get_menuoptions'

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, so the safety profile is covered; the description still adds real behavior: it actively rejects non-GET endpoints rather than silently failing, which is a policy worth knowing. It does not cover error shape or any auth/rate-limit behavior, which keeps it below 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: capability first, useful cases second, boundary plus alternative last. No filler and nothing buried.

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?

An output schema exists and annotations are rich, so the description need not explain return values; endpoint and params are documented in the schema. The only missing piece is how this generic pass-through relates to the other read-oriented siblings.

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% and the endpoint parameter already carries examples, so the baseline applies; the description adds meaning beyond the schema by constraining which endpoints are acceptable (read-only only) and framing 'params' as query parameters implicitly through the GET framing. It does not add syntax detail for the free-form params object.

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 concrete verb and resource ('chiama qualsiasi endpoint di SOLA LETTURA dell'API Yeastar (GET)') and immediately draws the read/write boundary by saying mutating endpoints are rejected. The enumeration of what it is useful for (CDR, report, stato live, registrazioni, log, menu options) makes the surface area concrete.

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?

Gives an explicit when-not and a named alternative: mutating endpoints go to yeastar_prepare_raw. However, among the read siblings (yeastar_get, yeastar_query, yeastar_search, yeastar_list) no routing guidance is offered, so an agent still cannot tell when this generic GET proxy is preferable to those.

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