Skip to main content
Glama

search_package_docs

Search official documentation of any npm, PyPI, or crates.io package by query, discovering relevant pages from its docs, homepage, and linked sources.

Instructions

Search a package's documentation for a query. Discovers pages from the registry's docs/homepage, llms.txt / llms-full.txt, sitemap.xml, and same-host links. Returns the highest-scoring pages with source URLs. Bounded to a small set of pages and characters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
queryYesFree-text query (matched case-insensitively)
packageYesPackage name
ecosystemNoLanguage/ecosystem (auto-detected if omitted)
max_pagesNoMax pages to return (default 15)
Behavior4/5

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

Describes discovery sources, result selection (highest-scoring pages), and bounding constraints. No annotations provided, so description carries the full burden; it adequately discloses non-destructive read behavior.

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?

Four sentences, front-loaded with purpose, zero wasted words. Efficiently covers purpose, sources, return format, and constraints.

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?

Given no output schema and complete parameter descriptions, description covers what the tool does, sources it uses, and result bounding. Lacks explicit return structure but sufficient for selection and invocation.

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% with clear descriptions for all 4 parameters. Description does not add additional detail beyond schema, so baseline of 3 is appropriate.

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?

Clearly states action (search), resource (package documentation), and scope (discovers pages from specific sources). Differentiates from sibling tools like get_package_docs and get_package_info by focusing on search and bounded results.

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?

Implies usage for searching documentation but lacks explicit when-to-use or when-not-to-use compared to siblings like get_package_docs. No guidance on alternatives or prerequisites.

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/eshaanmathakari/scoutdocs-mcp'

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