Skip to main content
Glama
Sign In
Nhost

Nhost

Official
by nhost
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Local

read_page

Read-onlyIdempotent

Retrieve the full content of an Nhost documentation page by path. Use after searching to get complete docs for a specific page.

Instructions

Read the full content of an Nhost documentation page. Use this after searching to get the complete documentation for a specific page.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "read_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesThe documentation page path (e.g., /products/auth/overview or products/auth/overview)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.52.0

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is fully covered by structured data. The description adds only the 'complete documentation' scope, with no notes on caching, freshness, or error behavior when a path is invalid.

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?

Two short sentences with the purpose front-loaded and the usage cue second; every clause earns its place with no redundancy.

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?

For a single-parameter read-only documentation lookup with full annotation coverage and no output schema, the description is nearly complete. Only minor edge-case guidance (invalid paths, path formatting) is absent.

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% and the single 'path' parameter is documented with an example in the schema, so the baseline is 3. The description adds no additional meaning about path format, leading-slash handling, or valid page identifiers beyond what the schema provides.

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 states a specific verb and resource — 'Read the full content of an Nhost documentation page' — which is distinct from sibling retrieval tools like search or list. It scopes the output as 'full content' versus search's partial results, though it does not name the sibling tool explicitly.

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

Usage Guidelines4/5

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

It gives a clear sequencing instruction: 'Use this after searching to get the complete documentation for a specific page,' telling the agent when the tool applies relative to search. It stops short of stating exclusions or 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.

Deploy Server

Other Tools