Ping (verify auth)
quaderno_pingVerify the API key and connection by pinging Quaderno. Returns account/authentication status. Quaderno API: GET /ping.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
quaderno_pingVerify the API key and connection by pinging Quaderno. Returns account/authentication status. Quaderno API: GET /ping.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
readOnlyHint=true already establishes that this is a safe, non-mutating call, and the description's mention of GET /ping reinforces that. It adds a little beyond annotations by saying it returns account/authentication status, but is silent on error behavior — whether an invalid key yields an error, a false flag, or a thrown exception.
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?
Three short sentences, front-loaded with the action and result, then the raw endpoint as a reference detail. Nothing is padded or repeated.
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 zero-param, read-only ping with no output schema, the description gives enough: what it does and what it returns. The one meaningful omission is how failure surfaces to the caller, which matters specifically for an auth-verification tool.
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?
The tool takes zero parameters, so there is nothing to disambiguate; baseline 4 applies. The description correctly implies no inputs are needed to perform the check.
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?
States a specific verb and resource — verify the API key and connection by pinging Quaderno — and is unmistakably distinct from every sibling, which are all data CRUD/list operations. An agent can tell at a glance this is the credential check.
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 purpose implies the usage (check credentials before/after setup), but the description never states when to call it — e.g. before a first call, after a key rotation, or on auth errors — nor does it warn against using it as a health probe in a loop. Usage is inferred rather than declared.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.