list_ping
Check if the Prowlarr server is online and responding to confirm API connectivity.
Instructions
Read Ping.
GET /ping
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Check if the Prowlarr server is online and responding to confirm API connectivity.
Read Ping.
GET /ping
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description 'Read Ping' adds no extra behavioral context, such as what a successful response looks like or whether it returns status details. It essentially repeats the read-only intent without enhancing the agent's understanding.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise: 'Read Ping.' and 'GET /ping'. It is front-loaded with the core action and the endpoint, with no redundant words or filler. Every character serves a purpose.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no parameters and a straightforward read-only purpose, the description is mostly sufficient. However, it does not mention what the response contains or how to interpret a successful ping, which could be useful for an agent verifying API health. A single sentence about the response would improve completeness, but the current description is acceptable for such a simple endpoint.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There are zero parameters, so the schema coverage is trivially complete. The description does not need to explain parameters, and it does not attempt to. Per the baseline rule for zero parameters, a score of 4 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the action 'Read' and the resource 'Ping', and includes the HTTP endpoint GET /ping. This is specific and unique among the sibling tools, which all follow a similar naming pattern but none other is about ping. It could be slightly more explicit in contrasting with alternatives, but the purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no guidance on when to use this tool versus others. It does not mention typical use cases, prerequisites, or conditions for choosing this endpoint. While it's a simple health check, an agent would benefit from knowing it is intended for connectivity or liveness verification.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.