Skip to main content
Glama

Create API monitor

create_api_monitor

Monitor JSON or REST endpoints where the response content matters, not just server availability. Ideal for health checks, webhooks, and APIs whose failures would otherwise go unnoticed.

Instructions

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.
Behavior4/5

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

Annotations already indicate non-read-only, non-idempotent, and non-destructive behavior. The description does not add extra context about side effects like authentication or rate limits, but it remains consistent with the annotations and adequately conveys the action of creating a monitor.

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 concise, consisting of two sentences that efficiently convey the purpose and usage context. It is well-structured and free of redundancy.

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?

The description covers the core functionality and usage scenarios adequately. While it does not mention the output or return value, the tool's simplicity and the presence of an output schema (even if not shown) reduce the need for such explanation.

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?

The input schema provides full descriptions for all five parameters, covering the essential semantics. The tool description itself does not add further parameter-specific details, so it stays at the baseline for well-covered schemas.

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 the tool's purpose: to monitor JSON or REST endpoints where response content matters. It also distinguishes it from the simpler HTTP monitor, making the intent unambiguous.

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 specifies when to use this tool (health endpoints, webhooks, APIs with content-dependent failures) and when not to use it (plain web pages, where the lighter HTTP monitor suffices). This gives clear guidance on alternative choices.

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/uptybots/mcp-server'

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