explore-apple-swift-docs
Explore Apple and Swift documentation across Xcode MCP docs, Dash, and official web docs, including search, browse, source selection, local-docs fallback, and optional Dash install or generation follow-up. Use when Codex needs Apple or Swift docs help rather than Xcode execution
What it does
Explore Apple Swift Docs
Purpose
Explore Apple and Swift documentation through one top-level entry point. Prefer direct docs access methods in this order: Xcode MCP docs first, Dash MCP second, Dash localhost HTTP third, and official web docs last. scripts/run_workflow.py remains a maintainer helper for structured dry runs, fallback planning, and Dash follow-up automation, but it is not the primary way the agent should perform ordinary Apple or Swift docs lookup.
When To Use
- Use this skill for Apple or Swift API reference lookup requests.
- Use this skill for Apple or Swift guide, tutorial, symbol, or concept search requests.
- Use this skill when the user wants local docs first, wants official docs first, or wants to compare available Apple or Swift docs sources.
- Use this skill when the user wants Dash-compatible Apple or Swift docs access, install guidance for a missing Dash docset, or generation guidance when a Dash docset is unavailable.
- Recommend
xcode-build-run-workflowwhen the user needs Apple or Swift execution, diagnostics, build, run, toolchain help, or mutation decisions inside an existing Xcode project. - Recommend
xcode-testing-workflowwhen the user needs Swift Testing, XCTest, XCUITest,.xctestplan, or test diagnosis inside an existing Xcode project. - Recommend
bootstrap-xcode-app-projectwhen the user is starting a brand new native Apple app project. - Recommend
sync-xcode-project-guidancewhen an existing Xcode app repo needsAGENTS.mdor workflow-guidance alignment rather than docs exploration.
Single-Path Workflow
- Classify the request into one docs workflow mode:
exploredash-installdash-generate
- If no mode is explicit, start at
explore. - For
explore, use the documented direct docs path instead of routing ordinary lookups through a wrapper script:xcode-mcp-docs: use Xcode MCP docs tools first when they are available and the user has not asked for another sourcedash: use Dash MCP tools directly when local Dash coverage is wanted and the MCP service is availabledash-http: use the documented Dash localhost HTTP structure directly when Dash MCP is unavailable or incompleteofficial-web: use official Apple or Swift web docs when the local-docs paths are unavailable or the user explicitly prefers the web source
- Use
scripts/run_workflow.pyonly when a structured non-interactive planning result is useful, or when the request is specifically aboutdash-installordash-generatefollow-up behavior. - If the selected mode cannot complete, hand off forward through one clear next step:
explore -> dash-installdash-install -> dash-generate
- Return one
status, onepath_type, onesource_used, and one output contract for the mode that ran.
Inputs
mode:explore,dash-install, ordash-generatequery: required forexploredocs_kind: optional forexplore; useapi-reference,guide,symbol, orsearchwhen the user intent is clearpreferred_source: optional forexplore; useauto,xcode-mcp-docs,dash, orofficial-webmcp_failure_reason: optional forexplorewhen Xcode MCP docs were expected but are currently unavailabledocset_request: required fordash-installanddash-generateapproval: required before side-effectful Dash install actions- Defaults:
exploresource order isxcode-mcp-docs,dash,official-web- Dash install source priority is
built-in,user-contributed,cheatsheet - default search result limit is
20 - default search snippets setting is
true - maintainer helper entrypoint: executable
scripts/run_workflow.py
Outputs
statussuccess: the selected mode completed on its primary or fallback pathblocked: prerequisites, approval, or usable docs sources are missinghandoff: the current mode is handing off to the next docs mode
path_typeprimary: the selected mode completed normallyfallback: the selected mode completed through its documented fallback path
outputmodesource_usedconfigured_orderorsource_pathmatches- install result or generation guidance when applicable
- one next step when follow-up is required
Guards and Stop Conditions
- Do not run Dash install actions without explicit user approval.
- Do not invent Apple or Swift doc sources, Dash identifiers, or catalog matches.
- Do not present
scripts/run_workflow.pyas the required first step for ordinary Apple or Swift docs lookup when direct Xcode MCP or Dash MCP/HTTP access is available. - Stop with
blockedwhenexplorehas no usable docs source after applying the documented fallback order. - Stop with
blockedwhendash-installordash-generatelacks a concrete docset request. - Keep
explore,dash-install, anddash-generatein forward order; do not blend them into competing primary workflows.
Fallbacks and Handoffs
explorefalls back in this order: Xcode MCP docs, then Dash MCP, then Dash localhost HTTP, then official web docs.- Explicit user preference overrides the default source order when that preference is usable.
dash-installhands off todash-generatewhen no installable catalog match exists.dash-generatefalls back from stable automation guidance to deterministic manual guidance.- Recommend
xcode-build-run-workflowdirectly when the user’s task shifts from docs exploration to Apple or Swift build, run, diagnostics, toolchain, or mutation work. - Recommend
xcode-testing-workflowdirectly when the user’s task shifts from docs exploration to Apple or Swift test work. - Recommend
bootstrap-xcode-app-projectdirectly when the user needs new native app scaffolding. - Recommend
sync-xcode-project-guidancedirectly when an existing Xcode app repo needs guidance sync rather than docs help. scripts/run_workflow.pyis the shared local helper for structured planning, install gating, and follow-up behavior; helper scripts remain implementation details behind it.
Customization
- Use
references/customization-flow.md. scripts/customization_config.pystores and reports customization state.scripts/run_workflow.pyloads and enforces the runtime-safe knobs documented inreferences/customization-flow.md.
References
Workflow References
references/xcode_mcp_docs.mdreferences/dash_mcp_tools.mdreferences/dash_call_library.mdreferences/apple-framework-docs-guide.mdreferences/dash-apple-docset-triage.mdreferences/dash-swift-package-shortlist.mdreferences/dash_http_api.mdreferences/dash_url_and_service.mdreferences/official_web_docs.md
Contract References
references/stage-handoff-contract.mdreferences/automation-prompts.mdreferences/customization-flow.md
Support References
- Recommend
references/snippets/apple-xcode-project-core.mdwhen the user needs a reusable Apple and Xcode-project baseline snippet in their own repo alongside Apple or Swift docs workflows. references/catalog_built_in_docsets.jsonreferences/catalog_user_contrib_docsets.jsonreferences/catalog_cheatsheets.jsonreferences/snippets/apple-xcode-project-core.md
Script Inventory
- These are maintainer helpers behind the public docs workflow, not the primary lookup path for ordinary Apple or Swift docs exploration.
scripts/run_workflow.pyscripts/dash_api_probe.pyscripts/dash_catalog_match.pyscripts/dash_catalog_refresh.pyscripts/dash_url_search.pyscripts/dash_url_install.py
Capabilities
Install
Quality
deterministic score 0.45 from registry signals: · indexed on github topic:agent-skills · 7 github stars · SKILL.md body (7,626 chars)