Skip to main content
Glama

ws_generate_client

Generate a WebSocket client for browser, Node, or React Native with auto-reconnect, event handling, and message queuing. Choose socket.io-client, ws, or native library and authenticate via API key.

Instructions

Generate a WebSocket client with auto-reconnect, event handling, and message queuing

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
eventsYesEvents the client should listen for
api_keyNoAPI key for authentication
platformNoTarget platformbrowser
frameworkNoClient library to usesocket.io-client
Behavior2/5

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

With no annotations, the description carries the full behavioral disclosure burden. It lists features (auto-reconnect, event handling, message queuing), but does not say whether the tool writes files, returns code, overwrites existing output, requires credentials beyond api_key, or has side effects. This is a significant transparency gap for a code-generation tool.

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?

A single front-loaded sentence with no filler: action, resource, and key features are stated efficiently. Every phrase earns its place.

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

Completeness3/5

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

The schema covers all parameters and the description gives the core purpose, so it is minimally viable. However, with no annotations and no output schema, the description omits what the generated client looks like, how platform/framework choices affect output, and whether filesystem changes occur.

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 description coverage is 100%, so the schema already documents events, api_key, platform, and framework. The description loosely aligns with 'events' and 'event handling', but adds no parameter-level meaning beyond what the schema provides. Baseline 3 is appropriate.

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 action and resource ('Generate a WebSocket client') and adds three concrete feature areas, so the tool's job is immediately clear. It does not explicitly differentiate it from sibling client generators such as presence_generate_client or sse_generate_client, but the name and WebSocket mention make the distinction mostly recoverable.

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

Usage Guidelines3/5

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

Usage is implied: this is for producing a WebSocket client with reconnect/event/queue behavior. However, there is no explicit guidance about when to choose it over ws_generate_server, sse_generate_client, or other realtime client tools, and no when-not-to-use conditions.

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/barnburner121/claude-plugin-marketplace'

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