Skip to main content
Glama

studio_read_doc

Read-onlyIdempotent

Read a manual: gb_api (the gb object of the app runtime), services (external APIs, libraries, keys), supabase (shared backend tables), proxy (secret keys), manifest (the fields of manifest.json), gbcontent (the app's sections whose content a page can display, and how to read it).

Input Schema

NameRequiredDescriptionDefault
topicYes
session_idYesThe session_id studio_open_page returned.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds only the content scope of the manual, not what is returned (full doc vs section, format) or whether a session must be open. That is a modest addition over annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence ('Read a manual: ...') with a dense but purposeful topic glossary. No filler, though the long parenthetical chain is harder to scan than a short list would be.

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

Completeness3/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 never indicates the shape of what comes back (markdown text, structured sections, length) or that session_id must come from studio_open_page. For a documentation-retrieval tool this leaves the return value underspecified.

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?

The schema only lists the enum values, but the description explains what each one actually contains (e.g. proxy = secret keys, gbcontent = the app's sections whose content a page can display). This meaningfully enriches the enum beyond the schema, which compensates for the 50% coverage gap where session_id is concerned.

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 ('Read') and resource ('a manual') and enumerates the six documentation topics it covers, so an agent can tell it apart from studio_read_file. It does not explicitly distinguish itself from studio_read_file or studio_get_app_context, keeping it short of a 5.

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 implied rather than stated: the enumeration of topics signals 'call this when you need to know about gb_api, services, supabase...'. There is no explicit when-to-use, no prerequisites (e.g. must call studio_open_page first), and no named alternative versus studio_read_file.

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.