ref_read_url
Read the content of a url as markdown. The EXACT url from a 'ref_search_documentation' result (including the #hash) should be passed to this tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the webpage to read. |
Read the content of a url as markdown. The EXACT url from a 'ref_search_documentation' result (including the #hash) should be passed to this tool.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the webpage to read. |
Changes observed during successful MCP inspections.
Input schema / additionalPropertiesRemoved value: -falseDoes the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds the genuinely useful disclosure that content is returned as markdown, which matters because there is no output schema. It omits failure behavior (dead links, JS-rendered or non-HTML pages) and any size or truncation limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, zero filler, with the core action front-loaded and the input constraint immediately after. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-parameter read tool with annotations covering safety, the description covers purpose, return format, and the exact input-source constraint, which is enough to call it correctly. Only edge-case behavior on unreachable or non-markdown content is unaddressed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the schema param text is only 'The URL of the webpage to read.' The description adds real meaning beyond it: the URL must originate from ref_search_documentation results and the #hash fragment must be preserved verbatim.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Read the content of a url as markdown') and explicitly positions itself against the sibling ref_search_documentation as the tool that consumes that tool's output. An agent can distinguish search from read without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives clear operational guidance: pass the EXACT url from a 'ref_search_documentation' result, including the #hash. That establishes the intended search-then-read sequence, though it does not say when NOT to use this tool or what to do with URLs obtained elsewhere.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.