Skip to main content
Glama

grocy_battery_get

Read-only

Retrieves details for a specific battery by its ID from a self-hosted Grocy instance so you can inspect battery information through the REST API.

Instructions

Details of one battery. GET /api/batteries/{batteryId}.

Input Schema

NameRequiredDescriptionDefault
battery_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds nothing beyond restating the endpoint — no behavior for missing/invalid IDs or error semantics, which is where extra context would have earned credit.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, the purpose front-loaded with the endpoint detail second. Minimal but appropriately sized for a simple lookup.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter read tool with safety annotations, the description is minimally sufficient to select and call it. However, there is no output schema and the description doesn't hint at what a battery record contains or how failures surface, leaving a real gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single required battery_id, so the description must carry the burden and it does not: the {batteryId} path token only restates the parameter name, giving no format, range, or existence semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Details of one battery') plus the underlying endpoint, which lets an agent distinguish it from grocy_batteries_list. No explicit sibling naming, but the singular/plural contrast is clear.

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?

Usage is only implied: fetch a single battery. It doesn't state when to prefer this over grocy_batteries_list or what to do if the ID is unknown, and no prerequisites are given.

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