Skip to main content
Glama
apinator-io

@apinator/mcp

Official
by apinator-io

Publish event

publish_event

Send an event to one or more Apinator channels so subscribed clients receive it immediately; cache channels store and replay it for future subscribers.

Instructions

Publish an event to one or more Apinator channels. Every client subscribed to those channels receives it immediately. On cache- channels the event is also stored and replayed to future subscribers. Pass exactly one of channel or channels.

Input Schema

NameRequiredDescriptionDefault
dataYesEvent payload. An object or array is sent as JSON; a string is sent as-is (clients JSON-decode it if they can).
nameYesEvent name, e.g. "order-created". Names starting with "realtime:" are reserved.
channelNoChannel to publish to, e.g. "orders" or "private-user-42".
channelsNoSeveral channels to publish the same event to (max 100).
socket_idNoExclude this connection from receiving the event (the sender's own socket).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=false, so the safety profile is covered. The description adds non-obvious semantics the annotations cannot express: immediate fan-out to subscribers and that cache- channels persist and replay the event to future subscribers, which materially affects a publish decision.

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, no waste, front-loaded with the core action and delivery behavior; the exclusivity constraint is placed last where a caller checks it before invoking. Every sentence earns its place.

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 publish tool with no output schema, the description covers delivery, persistence/replay, and the channel selection rule, which is sufficient to call it correctly. It omits any mention of what the call returns or error behavior, but with no output schema and full annotation coverage that gap is minor.

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 the baseline would be 3, but the description adds a genuine constraint absent from the schema: 'Pass exactly one of channel or channels.' The schema presents both as optional with no oneOf, so this mutual-exclusion rule is real value beyond the structured fields.

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?

States a specific verb (publish) and resource (event) plus the target (Apinator channels), and describes the delivery mechanism: subscribers receive it immediately, cache- channels store and replay. This clearly distinguishes it from the read/auth siblings (list_channels, get_channel, watct_channel, sign_channel_auth).

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

Usage Guidelines4/5

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

Gives a clear operational rule ('Pass exactly one of channel or channels') and explains the delivery context that decides reach. There is no competing publish sibling to route against, so no explicit alternative/exclusion language is needed, but no when-not guidance is offered either.

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