Skip to main content
Glama

Verify API key

securitytrails_ping
Read-onlyIdempotent

Check whether your SecurityTrails API key is valid by pinging the endpoint and returning a success flag.

Instructions

Check that the configured SecurityTrails API key is accepted. Returns only a success flag — use securitytrails_usage for quota figures.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
response_formatNo"markdown" for a compact human-readable summary, "json" for the full raw API payloadmarkdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
successYestrue when the API key is valid

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is well covered. The description adds meaningful behavioral context by stating the return is 'only a success flag' and clarifying what the check verifies. No contradiction with annotations.

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?

Two short, information-dense sentences. The purpose is front-loaded, and the sibling-tool pointer is included without waste.

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

Completeness5/5

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

Combined with rich annotations, a fully described optional parameter, and an output schema, the description covers everything an agent needs to select and invoke this tool correctly. Nothing critical is missing.

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

Parameters3/5

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

Schema description coverage is 100% and the single optional parameter response_format is fully documented in the schema, including its enum and default. The description adds no parameter-level detail, so the baseline of 3 is appropriate.

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 states a specific operation ('Check that the configured SecurityTrails API key is accepted') and clearly names the resource it acts on. It also distinguishes itself from securitytrails_usage by noting that only a success flag is returned.

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 gives clear context for use (verifying API key acceptance) and explicitly routes quota-related needs to a sibling tool: 'use securitytrails_usage for quota figures.' This is direct and actionable.

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