Skip to main content
Glama

get_markdown

Read-only

Extract a web page or selected element as compact Markdown for reading or analysis; optionally strip navigation and footers, shorten links, and page long content by offset.

Instructions

Page (or element) as compact markdown (untrusted page content). main_only drops menus, footers and cookie banners. links: keep | short (no query strings) | none (text only, cheapest). Long pages are paged with offset; to look for one thing use find_in_page instead.

Input Schema

NameRequiredDescriptionDefault
linksNokeep
offsetNo
selectorNobody
main_onlyNo
max_charsNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare read-only, non-destructive, open-world behavior. The description adds useful context beyond annotations, including untrusted content, main_only filtering, links cost tradeoffs, and pagination via offset.

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?

The description is compact and front-loaded: format and scope come first, followed by key option behavior and the find_in_page alternative. Every sentence carries useful information.

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?

An output schema exists, so return-value detail is not required. The description covers the main behavioral choices and pagination, but gaps around selector and max_chars keep it from being fully complete for a five-parameter tool.

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 description coverage is 0%, so the description must carry parameter meaning. It explains links modes, main_only, and offset well, but does not explain selector or max_chars, leaving two of five parameters undocumented beyond the schema.

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?

The description clearly states the resource and output format: page or element content as compact markdown. It distinguishes itself from find_in_page, though it does not explicitly differentiate from siblings like get_text, get_html, or snapshot.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives a clear alternative for a common case: 'to look for one thing use find_in_page instead.' It also explains main_only and links behavior, but does not fully state when to choose this over get_text/get_html/snapshot.

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