Skip to main content
Glama

test_api_connection

Test API connection and credentials to troubleshoot issues or verify setup. Returns success confirmation or error details.

Instructions

Test the API connection and credentials.

Use when troubleshooting connection issues or verifying API setup. Returns "OK" if successful or error details if failed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
debugNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
metadataYesMetadata about the data itself
summaryYesHuman-readable insights
debugYes
successYes
api_versionNocurrent
response_versionNo1.0
Behavior4/5

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

The description indicates the tool returns 'OK' or error details, which is informative. However, since no annotations are provided, it could explicitly state that the operation is non-destructive and safe to run.

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?

The description is two short sentences, front-loading the purpose immediately with no superfluous words. Every sentence is essential.

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?

The description covers purpose, usage, and return type, but misses explanation for the 'debug' parameter. Given the simplicity of the tool and existence of an output schema, it is nearly complete but has a notable 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?

The input schema has one boolean parameter 'debug' with no description, and the tool description does not explain its purpose or effect. Given 0% schema description coverage, the description should compensate but fails to do so.

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?

The description explicitly states 'Test the API connection and credentials', which is a specific verb and resource. It is distinct from all sibling tools, which focus on tasks, projects, or time tracking.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear usage context: 'Use when troubleshooting connection issues or verifying API setup.' No sibling tool has a similar purpose, so no alternative is needed.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bgheneti/Amazing-Marvin-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server