Skip to main content
Glama
snyk-labs

Node.js API Documentation MCP Server

by snyk-labs

get_api_for-zlib

Query Node.js Zlib API documentation by providing a class and method name to get detailed information.

Instructions

Node.js API: Zlib

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?

With no annotations and a minimal description, the agent is left unaware of the tool's behavior. No mention of side effects, permissions, data safety, or return format. The description fails to disclose that this is a read-only API lookup tool.

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?

The description is extremely brief (one line), but it sacrifices clarity for brevity. It is under-specified rather than concise. A concise description would still convey the verb and scope without being vague.

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 the lack of output schema and the tool's likely role in retrieving API documentation, the description is insufficient. It does not explain what the tool returns or how to interpret results, leaving significant gaps for the agent.

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?

The input schema provides clear descriptions for the two parameters (class and method), achieving 100% coverage for actual parameters. The tool description adds no extra semantic value beyond the schema, meeting the baseline for a case with good schema coverage.

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: Zlib' is a label rather than a clear statement of the tool's action. It lacks a verb and doesn't specify whether the tool retrieves, searches, or lists API information. The name suggests a retrieval function, but the description provides minimal clarity.

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

Usage Guidelines1/5

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

No guidance is provided on when to use this tool versus its siblings (other module-specific tools). There is no information about context, prerequisites, or alternatives, leaving the agent without direction for appropriate invocation.

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