Skip to main content
Glama

get_sec_api_status

Read-onlyIdempotent

Verify SEC API availability and connectivity before querying EDGAR filings or financial data.

Instructions

Check SEC API status and connectivity.

Returns: Dictionary containing API status information

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds only that connectivity is checked in addition to status, and it never says what a degraded result looks like or whether the tool can be used to verify credentials. Useful but thin beyond what annotations provide.

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?

The operational sentence is front-loaded and tight. The trailing 'Returns: Dictionary containing API status information' is largely redundant because an output schema exists, which costs it one point but not more.

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

Completeness4/5

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

For a zero-parameter diagnostic tool with an output schema and full annotation coverage, the definition supplies enough to call it correctly. It is only missing practical framing such as when to invoke it or how to interpret a failure result.

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

Parameters4/5

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 document. The schema is an empty object and the description correctly implies no inputs are required, which is the baseline for no-parameter tools.

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?

The description names a specific verb and resource: 'Check SEC API status and connectivity.' That is clearly distinguishable from every sibling, all of which retrieve filings or company data. It stops short of a 5 only because 'status' is a slightly generic notion, but an agent can still tell what this tool is for.

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

Usage Guidelines2/5

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

The description says nothing about when to call this instead of alternatives. The sibling run_self_test looks like it also performs a health check, yet the description draws no distinction and gives no trigger condition, for example 'call before other SEC tools if requests are failing.'

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