Skip to main content
Glama

Search Apple Developer Documentation

search_apple_docs

Search Apple API symbols and documentation by name across official framework indexes, with optional framework filters, to locate the right reference path for full details.

Instructions

Search Apple API symbols (types, methods, properties, articles) by name. Runs over Apple's official per-framework documentation index. Without frameworks it searches a default set (SwiftUI, FamilyControls, ManagedSettings, DeviceActivity, SwiftData, Foundation, UIKit, WidgetKit, AppIntents, StoreKit, Swift, …) plus any framework named in the query. Use symbol names, e.g. "AuthorizationCenter", "ManagedSettingsStore shield", "NavigationStack". Then call get_apple_doc with a result path for full details.

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": {
      "query": "<query>"
    },
    "name": "search_apple_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMax results (default 15)
queryYesSymbol or topic name, e.g. "DeviceActivityMonitor" or "List selection"
frameworksNoFramework slugs to restrict to, e.g. ["swiftui"]. See list_apple_frameworks.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does disclose meaningful behavior: it runs over Apple's official per-framework index, and without the frameworks filter it searches a named default set plus any framework mentioned in the query — a non-obvious scoping rule. It does not describe the shape of returned results beyond the fact that each has a path, nor any rate/caching behavior, but the essential semantics are covered.

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?

Four sentences, front-loaded with the core action, followed by scoping rules, query guidance, and the next step. The trailing ellipsis in the default framework list is the only mild noise, and every other clause adds decision-relevant 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?

There is no output schema, so the description must carry the return-value burden; it partially does by indicating results have paths consumable by get_apple_doc, but it never says what else a result contains (title, abstract, symbol kind). For a three-parameter read tool with a clear handoff, this is nearly complete but leaves the result shape implicit.

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 would be 3; the description earns above that by explaining the non-obvious interaction between the query and the frameworks filter (default set plus frameworks named in the query) and by giving richer query-string examples than the schema's single example. It says nothing additional about the limit parameter beyond what the schema already states.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Search Apple API symbols (types, methods, properties, articles) by name") and scopes it to Apple's official per-framework documentation index. The final sentence distinguishes it from the sibling get_apple_doc by describing the two-step search-then-fetch workflow, so an agent can pick correctly 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.

Usage Guidelines4/5

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

Gives concrete usage guidance with example queries ("AuthorizationCenter", "ManagedSettingsStore shield", "NavigationStack") and explicitly routes the agent onward: "Then call get_apple_doc with a result path for full details." It also explains the default-framework fallback. It does not state when to skip this tool (e.g., when the doc path is already known), so it falls short of full when/when-not coverage.

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