Skip to main content
Glama

Create API monitor

create_api_monitor

Watch a JSON or REST endpoint where the response itself matters, not only that the host answered. Use it for health endpoints, webhooks and any API whose failure would be invisible to a plain page check. For an ordinary web page, create_http_monitor is lighter and enough.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesFull endpoint URL including scheme, for example https://api.example.com/v1/status.
nameYesLabel shown in the dashboard and in alerts, up to 50 characters. Something recognisable months later beats the bare hostname.
isActiveNoStart monitoring immediately (default true)
frequencyNoCheck frequency in minutes (1-1440, default 5)
requestTimeoutNoRequest timeout in seconds (1-60, default 30)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesMonitor id, used by every other tool.
urlNo
nameNo
typeNo
isActiveNoFalse while the monitor is paused.
frequencyNoCheck interval in minutes.
statusSummaryNoCurrent state, for example GOOD or ERROR.

TDQS

A4.7/5.0
Behavior4/5

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

Annotations declare openWorldHint=true and readOnlyHint=false, and the description appropriately explains the tool watches endpoints where the response matters but doesn't go into details like authentication requirements or rate limits. The description does add value by clarifying the semantics of what 'monitor' means here (response content matters, not just host availability), which goes beyond the annotations. However, it could have mentioned whether creation is idempotent or what happens on duplicate monitors, though the annotations cover idempotentHint=false.

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?

Three sentences total. The first states the core purpose, the second gives concrete examples, and the third provides the pointer to the sibling tool. Every word earns its place.

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?

Given the tool has only 5 simple parameters (all covered by schema), an output schema, and useful sibling tools, the description is complete. It explains the tool's purpose, gives usage guidance, and points to an alternative without unnecessary details about return values (since output schema exists) or parameter syntax (since schema covers them).

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?

Schema coverage is 100%, so parameters are well-documented in the schema. The description adds conceptual context for the 'name' parameter ('Something recognisable months later beats the bare hostname') and clarifies the tool focuses on response content. While the description itself doesn't enumerate parameters, it works with the fully-covered schema to give complete semantic understanding. The description could have added more behavioral details about how parameters like frequency interact with monitoring behavior, but the schema covers the basics well.

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 clearly states this tool watches JSON/REST endpoints where the response content matters, distinguishing it from a plain page check. It names the specific use case (health endpoints, webhooks, APIs) and explicitly contrasts with create_http_monitor, making the purpose and differentiation clear.

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 explicitly says when to use this tool ('for health endpoints, webhooks and any API whose failure would be invisible to a plain page check') and provides a concrete alternative ('For an ordinary web page, create_http_monitor is lighter and enough'). This is a model example of usage guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.4/5.0
Disambiguation5/5

Every tool has a clearly distinct purpose. The six monitor creation tools are explicitly differentiated in their descriptions (e.g., HTTP vs API vs SSL vs domain), and lifecycle tools like delete, pause, resume, and list are unambiguous. Overlap is minimal and explicitly addressed.

Naming Consistency5/5

All tool names follow a consistent snake_case verb_noun pattern (e.g., create_http_monitor, get_stats_hourly, pause_monitor). No mixed conventions or vague verbs; the pattern is uniform and predictable.

Tool Count4/5

15 tools is on the higher end of the ideal range, but each tool earns its place. The count reflects a comprehensive monitoring surface without unnecessary redundancy. Slightly over the typical sweet spot, but justified by the domain.

Completeness4/5

The tool surface covers creation, deletion, pause/resume, listing, retrieval, incident history, and two levels of statistics, plus notifications. A notable gap is the absence of an update/edit tool for existing monitors, which agents may need to adjust configurations. Otherwise, the lifecycle is well covered.

Resources