Skip to main content
Glama
apinator-io

@apinator/mcp

Official
by apinator-io

Sign channel auth

sign_channel_auth
Read-only

Generate auth signatures clients need to subscribe to private or presence channels, matching your auth endpoint for testing and debugging mismatches. Presence channels need channel_data with user_id.

Instructions

Compute the auth signature a client needs to subscribe to a private- or presence- channel, exactly as your auth endpoint would return it. Useful for testing an auth flow or debugging a signature mismatch. Presence channels need channel_data with a user_id.

Input Schema

NameRequiredDescriptionDefault
channelYesA "private-" or "presence-" channel.
socket_idYesSocket id of a connected client, from realtime:connection_established (e.g. "node-eu-1.42").
channel_dataNoPresence member data, e.g. {"user_id":"42","user_info":{"name":"Ada"}}. Required for presence channels.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations cover the safety profile (readOnlyHint=true, openWorldHint=false). The description adds real context beyond that: it is a pure computation mirroring the auth endpoint's output, plus the presence-channel channel_data requirement. It doesn't state whether it produces side effects (it doesn't, implied by annotations) or the exact return shape, but the added behavioral context is solid.

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 tight sentences, front-loaded with the core action, then use cases, then the one conditional requirement. No wasted words.

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 no-output-schema tool, the description adequately conveys what is produced ('exactly as your auth endpoint would return it') and documents the input requirements. Only the literal return type/format is left implicit, which is a minor gap given the deterministic nature of the operation.

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 coverage is 100%, so the schema already documents all three parameters with examples. The description reinforces the presence/channel_data link, but that fact is already in the schema's parameter description, so it adds little beyond baseline.

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 precise verb and resource: compute the auth signature for a private- or presence- channel subscription. It is immediately distinguishable from all siblings (list_channels, get_channel, publish_event, watch_channel), none of which involve signing.

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 clear when-to-use context: 'testing an auth flow or debugging a signature mismatch.' It also flags the presence-channel condition for channel_data. No explicit when-not guidance or named alternatives, but the usage intent is unambiguous.

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