Skip to main content
Glama

wsauth_generate

Generate WebSocket authentication for your project by specifying its directory and optional API key, enabling secure client access to WebSocket endpoints.

Instructions

Generate WebSocket authentication

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyNo
directoryYesProject directory
Behavior1/5

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

No annotations are provided, so the description carries the full burden of behavior disclosure. It only says 'Generate WebSocket authentication' with no indication of what files are created, whether auth is token-based (JWT/HMAC/OAuth), whether it modifies an existing project, or what side effects occur in the specified directory.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence with no wasted words. However, it is under-specified rather than efficiently detailed — it earns its place as a topic statement but omits essential specifics that structured content should carry.

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

Completeness2/5

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

For a generation tool with two parameters and no output schema, the description should at least state what it produces and how api_key factors in. Given a large sibling set in adjacent domains, this description is too thin for an agent to safely invoke without further inference.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 50% (directory is described, api_key is not) and the description adds no parameter context. It does not explain how api_key is used in generating authentication, nor does it clarify the role of directory beyond the schema's 'Project directory' note.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a verb ('Generate') and a resource ('WebSocket authentication'), which identifies the general domain but not the specific deliverable. It doesn't distinguish wsauth_generate from siblings like wsauth_add_tokens, ws_generate_server, or jwt_generate_auth — an agent cannot tell whether this produces a token service, middleware, or configuration files.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus alternatives. With many auth-related siblings (jwt_generate_auth, oauth_generate_flow, wsauth_add_tokens, ws_generate_server), the absence of any selection criteria leaves the agent to guess at the appropriate context.

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