Skip to main content
Glama
MCP Spark Documentation Server

MCP Spark Documentation Server

by martoc

read_documentation

Retrieve the full content of a specific Apache Spark documentation page by providing its relative path, so you can inspect exact details beyond search snippets.

Instructions

Read the full content of a specific Spark documentation page.

Input Schema

NameRequiredDescriptionDefault
pathYesThe relative path to the documentation file (e.g., 'sql-ref/sql-syntax.md' or 'api/python/index.md'). This path is returned in search results.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.7
    • addedInput schema / properties / path / description
      Added value: +"The relative path to the documentation file (e.g.,\n  'sql-ref/sql-syntax.md' or 'api/python/index.md'). This path\n  is returned in search results."
  2. Changed1 schema field changedv0.2.6
    • addedInput schema / additionalProperties
      Added value: +false
  3. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose one useful trait: it returns the FULL page content rather than a snippet. It does not address page size or truncation, whether an invalid path errors or returns empty, or any cost/latency characteristics of fetching whole documents.

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?

One sentence, front-loaded with the verb and resource, with zero redundant wording. Nothing to trim and nothing buried.

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 one-parameter read tool with an output schema that covers return values, the description is nearly sufficient; the remaining gap is the missing explicit hand-off from search_documentation to this tool. The schema compensates for path semantics, so completeness is high.

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% and the single `path` parameter is documented with concrete examples and its provenance (returned in search results), so the schema already does the work. The description adds nothing about path format or validation beyond that, which is the correct baseline for a fully described single parameter.

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?

"Read the full content of a specific Spark documentation page" gives a specific verb (read) and resource (documentation page) and scopes it to a single page, which implicitly separates it from search_documentation. It stops short of naming the sibling outright, so an agent must infer the contrast.

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 phrase "a specific page" plus the schema note that paths are returned in search results suggests this is the follow-up call after a search. There is no explicit statement of when to use this versus search_documentation, nor any precondition about obtaining a path first.

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