Skip to main content
Glama

Read a Jev docs page

jev_docs_read
Read-only

Read the full Markdown of one Jev documentation page by passing a path, docs.typesafe.ai URL, or exact title; use offset to page through long content.

Instructions

Read the full Markdown of one Jev documentation page. Accepts a path (e.g. 'primitives/noul'), a docs.typesafe.ai URL, or an exact page title. Long pages are paginated with offset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYesPage path, URL, or title
offsetNoCharacter offset to start from, for long pages
max_charsNoMaximum characters to return

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds real behavioral context the annotations do not: long pages are paginated and require an offset, and it discloses the three input forms accepted for a page reference.

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?

Three short sentences, zero filler, with the core action front-loaded and input forms and pagination following in order of importance.

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

Completeness5/5

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

For a read-only, no-output-schema tool, the description covers the action, all accepted page-reference forms, and pagination behavior. Nothing an agent needs in order to invoke it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description goes beyond the schema by giving a concrete path example ('primitives/noul') and by tying the offset parameter to its purpose (pagination of long pages). That adds usable format guidance not present in the schema text.

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?

States a specific verb and resource ('Read the full Markdown of one Jev documentation page') and the singular scope plus 'full Markdown' implicitly separates it from jev_docs_list and jev_docs_search. It stops short of naming those siblings explicitly, so the differentiation is inferable rather than stated.

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?

The description explains the accepted input forms but gives no when-to-use or when-not-to-use guidance, and does not route the agent to jev_docs_search or jev_docs_list for finding an unknown page. Usage is implied (read a page once you know its path/title) rather than spelled out.

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