Skip to main content
Glama
snyk-labs

Node.js API Documentation MCP Server

by snyk-labs

get_api_for-stream

Retrieve Node.js Stream API documentation by specifying a class name and optional method. Access details for Stream classes and methods to understand their usage.

Instructions

Node.js API: Stream

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
classNoThe class name to search for.
methodNoThe method name to search for.
requiredNo
Behavior1/5

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

No annotations are provided, and the description contains no behavioral information such as side effects, read-only nature, rate limits, or output format. For a likely read-only documentation lookup, the description should disclose that it returns API documentation and does not mutate data.

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

Conciseness2/5

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

Extremely short (5 words) but under-specified. Conciseness without substance is not valuable; the description sacrifices informativeness for brevity.

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

Completeness1/5

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

Given no annotations, no output schema, and a high number of sibling tools, the description is critically incomplete. It provides no details on return values, error conditions, or how the tool integrates with the broader set of Node.js API tools.

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?

The schema covers both parameters with descriptions (67% coverage reported, but actual schema shows 2 params with descriptions), but the tool description adds no extra meaning. It fails to explain how 'class' and 'method' parameters relate to the Stream API (e.g., Node.js class vs. method scope), leaving ambiguity.

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

Purpose2/5

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

The description 'Node.js API: Stream' is a label rather than an explanation. It does not specify an action (e.g., retrieve, list, search) and only identifies the API domain. Among siblings, it weakly implies it's for the Stream module, but the purpose is vague.

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 siblings like get_api_for-http or search-nodejs-modules-api-documentation. The context of sibling names implies module-specific retrieval, but the description lacks any explicit when-to-use or when-not-to-use information.

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/snyk-labs/mcp-server-nodejs-api-docs'

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