Skip to main content
Glama

BlockVectra: multi-chain RPC & Data API

Read Documentation Page

read_doc
Read-only

Read the raw Markdown content of a documentation page from /md/{lang}/{path}.md. Path must be an internal relative path (e.g. 'quickstart', 'guides/ai-agents', 'api/json-rpc', 'chains').

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
langNoPublished documentation language (case-insensitive, e.g. zh-hant or zh-Hant). Omit for English; unavailable languages return an error.
pathYesInternal relative documentation path (e.g. 'quickstart', 'guides/ai-agents', 'api/json-rpc'). Do not include protocol, hostname, query string, fragment, or '..'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / lang / description
      Previous value: -"Published documentation language. Omit for English; unavailable languages return an error."New value: +"Published documentation language (case-insensitive, e.g. zh-hant or zh-Hant). Omit for English; unavailable languages return an error."
  2. Changed1 schema field changed
    • changedInput schema / properties / lang / enum
      Previous value: -[
      -  "en",
      -  "zh",
      -  "de",
      -  "es",
      -  "fr",
      -  "id",
      -  "ja",
      -  "ko",
      -  "pt-br",
      -  "ru",
      -  "tr",
      -  "vi",
      -  "zh-hant"
      -]New value: +[
      +  "en",
      +  "zh",
      +  "de",
      +  "es",
      +  "fr",
      +  "id",
      +  "ja",
      +  "ko",
      +  "pt-br",
      +  "ru",
      +  "th",
      +  "tr",
      +  "uk",
      +  "vi",
      +  "zh-hant"
      +]
  3. Changed1 schema field changed
    • changedInput schema / properties / lang / enum
      Previous value: -[
      -  "en",
      -  "zh",
      -  "es",
      -  "id",
      -  "ja",
      -  "ko",
      -  "pt-br",
      -  "ru",
      -  "vi",
      -  "zh-hant"
      -]New value: +[
      +  "en",
      +  "zh",
      +  "de",
      +  "es",
      +  "fr",
      +  "id",
      +  "ja",
      +  "ko",
      +  "pt-br",
      +  "ru",
      +  "tr",
      +  "vi",
      +  "zh-hant"
      +]
  4. Changed1 schema field changed
    • changedInput schema / properties / lang / enum
      Previous value: -[
      -  "en",
      -  "zh",
      -  "es",
      -  "id",
      -  "ja",
      -  "ko",
      -  "pt-br",
      -  "vi",
      -  "zh-hant"
      -]New value: +[
      +  "en",
      +  "zh",
      +  "es",
      +  "id",
      +  "ja",
      +  "ko",
      +  "pt-br",
      +  "ru",
      +  "vi",
      +  "zh-hant"
      +]
  5. Changed1 schema field changed
    • changedInput schema / properties / lang / enum
      Previous value: -[
      -  "en",
      -  "zh",
      -  "ja",
      -  "ko",
      -  "pt-br"
      -]New value: +[
      +  "en",
      +  "zh",
      +  "es",
      +  "id",
      +  "ja",
      +  "ko",
      +  "pt-br",
      +  "vi",
      +  "zh-hant"
      +]
  6. Changed1 schema field changed
    • changedInput schema / properties / lang / enum
      Previous value: -[
      -  "en",
      -  "zh",
      -  "ko"
      -]New value: +[
      +  "en",
      +  "zh",
      +  "ja",
      +  "ko",
      +  "pt-br"
      +]
  7. Changed1 schema field changed
    • changedInput schema / properties / lang / enum
      Previous value: -[
      -  "en",
      -  "zh"
      -]New value: +[
      +  "en",
      +  "zh",
      +  "ko"
      +]
  8. Changed1 schema field changed
    • changedInput schema / properties / lang / description
      Previous value: -"Documentation language: 'en' for English or 'zh' for Chinese. Defaults to 'en'."New value: +"Published documentation language. Omit for English; unavailable languages return an error."
  9. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds that the return value is raw Markdown, which is useful beyond the annotations, but says nothing about missing-page errors, size limits, or caching 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?

Two sentences, no filler, with the resource and route front-loaded followed by the path constraint. Every clause earns its place.

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?

With no output schema, the description correctly states what is returned (raw Markdown), and the parameter contract is fully documented by the schema plus annotations. Minor gaps remain around error handling for unavailable languages or missing paths, which the schema only partially covers.

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 description coverage is 100%, so the baseline is 3, but the description adds value by showing how lang and path compose into the URL template (/md/{lang}/{path}.md) and by providing an extra path example not in the schema. It reinforces rather than merely repeats the constraints.

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?

States a specific verb ("Read") and resource ("raw Markdown content of a documentation page") and even exposes the underlying route (/md/{lang}/{path}.md). This clearly distinguishes it from siblings like list_docs and search_docs, which enumerate or query rather than fetch a specific page's raw content.

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?

Usage is only implied: the agent can infer it should call this to fetch one known page's raw text, but no explicit when-to-use or when-not-to-use guidance is given, and no alternatives (search_docs, list_docs) are named. The path-format constraint is parameter guidance, not usage routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.