Skip to main content
Glama

Get Apple documentation page

get_apple_doc

Fetches an Apple documentation page from a path or URL as Markdown, including declarations, availability, discussion, code samples, parameters, and topic links.

Instructions

Fetch one Apple documentation page as Markdown: declaration, availability (min iOS version, deprecation), discussion, code samples, parameters and topic links. Accepts a path like "/documentation/familycontrols/authorizationcenter", a full developer.apple.com URL, or "framework/symbol".

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "get_apple_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesDocumentation path or URL
include_topicsNoInclude the Topics / See Also link lists (default true)
max_topics_per_sectionNoLinks per topic section (default 15)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/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; it does well on output shape (Markdown, declaration, availability, discussion, code samples) and mentions default behaviors for topics. It omits error behavior for invalid or missing paths, whether content is truncated for large pages, and any rate limits or auth requirements.

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?

Two sentences, front-loaded with the core action and return contents, followed by input formats. No filler and nothing redundant with the schema beyond what is needed for clarity.

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?

No output schema exists, so the description must describe the returned content, and it does so concretely. Combined with full schema coverage and disclosed defaults, an agent has enough to call it correctly; only failure-mode details are absent.

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?

Schema description coverage is 100%, so the baseline is 3, but the description adds real value on the 'path' parameter by giving three concrete accepted formats including a worked example path. This goes beyond the schema's terse 'Documentation path or URL' and reduces the chance of a malformed invocation.

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 ('Fetch one Apple documentation page as Markdown') and enumerates what the page contains (declaration, availability, discussion, code samples, parameters, topic links). The word 'one' implicitly contrasts with search-style siblings, but no sibling is named, so differentiation is only inferable.

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?

The description explains accepted input forms (path, full developer.apple.com URL, 'framework/symbol') which helps the agent supply a path, but it never says when to reach for this versus search_apple_docs or list_apple_frameworks, nor any when-not condition. Usage is implied rather than stated.

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