Skip to main content
Glama

API GET

api_get
Read-only

Fetches an authenticated platform endpoint using session cookies and auth headers, optionally saving the response body to a workspace file.

Instructions

Advanced: GET a platform endpoint (discovered with open_page) with the session cookies and auth headers. Optionally save the body to a file in the workspace.

Input Schema

NameRequiredDescriptionDefault
urlYes
saveToNoFile path relative to the workspace
maxCharsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, and the description adds meaningful context beyond them: requests are made with the session cookies and auth headers (so auth is inherited, not supplied), and the body can be persisted to a workspace file. It does not say what a file save does to an existing file or how truncation behaves, but the auth and side-effect disclosures are the important ones.

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?

Two sentences, zero filler, with the core action and the discovery workflow front-loaded. The leading 'Advanced:' label is slightly vague but does usefully set expectations about the audience.

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?

An openWorldHint read tool with annotations carrying the safety profile, so the bar is lower, but the description still leaves open how the response is shaped, what maxChars truncation does to it, and what happens on auth failure — all things an agent calling an arbitrary endpoint would want to know.

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?

Only saveTo has schema documentation (33% coverage). The description covers url and saveTo in prose ('GET a platform endpoint', 'save the body to a file in the workspace'), but maxChars — a truncation limit with a default and a 200000 maximum — is explained nowhere, which matters because it silently bounds the returned body.

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 (GET a platform endpoint) and adds a key qualifier: the endpoint is one 'discovered with open_page', which separates it from the browser-navigation siblings (open_page, click) and the domain-specific readers (get_lesson, get_transcript). It lacks an explicit contrast statement with those siblings, so it stops short of 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?

'Advanced:' and the parenthetical tying it to open_page imply a two-step workflow (discover, then fetch), which is real usage context. But there is no explicit when-to-use-this-instead-of-open_page guidance and no stated prerequisites or failure conditions (expired cookies, unauthorized endpoints).

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