Skip to main content

Version-aware mobile docs MCP server for Android (Jetpack/Compose) and Apple (SwiftUI/UIKit)

Project description

mobile-docs-mcp

A version-aware documentation MCP server for mobile development — the context7 idea, but specialized for the thing generic doc proxies get wrong: which version of an API you can actually use.

It indexes Android (Jetpack / androidx / Compose) and Apple (SwiftUI / UIKit) documentation with since / deprecated / removed metadata on every symbol, so an agent can verify an API exists on the version the project targets before writing code against it.

Why it's different from a doc proxy

Most "Apple docs" / "Android docs" MCP servers live-fetch and parse the current doc site. They answer "what is scrollTargetBehavior?" but not "can I use it on iOS 16?" — and that second question is where coding agents hallucinate. Every result here is filtered and annotated against a target version.

Tools

Tool Purpose
search_mobile_docs Hybrid (BM25 + optional vector) retrieval, filtered by platform + target version
get_api_reference Full symbol card: signature, availability, deprecation/migration pointer
verify_api_exists Anti-hallucination check — real AND usable on a given version?
list_api_versions since / deprecated / removed timeline + migration lineage
get_release_notes What changed in a library/version

Example verdict:

verify_api_exists("scrollTargetBehavior", "16.0", "apple")
→ ❌ NOT AVAILABLE — introduced in 17.0, newer than 16.0. Will not compile there.

Run

# From source
pip install -e .
python -m mobile_docs_mcp.server        # stdio transport

# Once published
uvx mobile-docs-mcp

Ships with a seed corpus, so it works immediately with no crawl.

Editor & IDE setup (iOS + Android)

The server speaks MCP over stdio, so any MCP-capable editor can use it. All the tools work for both platforms — you'll lean on the SwiftUI entries in an iOS project and the Compose/androidx entries in an Android one, but nothing is editor-specific. Two ways to launch it:

  • From source (this repo): command: "python", args: ["-m", "mobile_docs_mcp.server"], with cwd set to the repo path.
  • Once published: command: "uvx", args: ["mobile-docs-mcp"] (no cwd needed).

Set MOBILE_DOCS_DATA in env to layer in any corpora you've crawled with the ingesters (see "Growing the index").

Claude Code (CLI)

# from source, shared with the repo via .mcp.json (project scope)
claude mcp add mobile-docs-mcp --scope project -- python -m mobile_docs_mcp.server
# or, once published
claude mcp add mobile-docs-mcp -- uvx mobile-docs-mcp

Verify with claude mcp list, or /mcp inside a session.

Claude Desktop

Edit claude_desktop_config.json (Settings → Developer → Edit Config), then restart the app:

{
  "mcpServers": {
    "mobile-docs-mcp": {
      "command": "python",
      "args": ["-m", "mobile_docs_mcp.server"],
      "cwd": "/absolute/path/to/mobile-docs-mcp",
      "env": { "MOBILE_DOCS_DATA": "data/android,data/apple" }
    }
  }
}

Cursor

Create .cursor/mcp.json in the project root (or ~/.cursor/mcp.json for all projects) — same mcpServers shape as above:

{
  "mcpServers": {
    "mobile-docs-mcp": {
      "command": "python",
      "args": ["-m", "mobile_docs_mcp.server"],
      "cwd": "${workspaceFolder}"
    }
  }
}

Then enable it under Settings → MCP.

Windsurf

Edit ~/.codeium/windsurf/mcp_config.json (Cascade panel → MCP icon → Configure). Same mcpServers shape; Windsurf supports ${env:VAR} interpolation so you can keep paths/secrets out of the file:

{
  "mcpServers": {
    "mobile-docs-mcp": {
      "command": "python",
      "args": ["-m", "mobile_docs_mcp.server"],
      "cwd": "/absolute/path/to/mobile-docs-mcp"
    }
  }
}

Android Studio

Gemini in Android Studio is an MCP client. Go to Settings → Tools → AI → MCP Servers, tick Enable MCP Servers, and paste the same mcpServers JSON block shown for Claude Desktop. Confirm with the "Successfully connected" notification, then type /mcp in the chat to see the tools. Great for checking androidx/Compose availability against your module's compileSdk / library versions without leaving the IDE.

VS Code

VS Code's key is servers (not mcpServers) and wants an explicit type. Create .vscode/mcp.json (commit it to share with the team):

{
  "servers": {
    "mobile-docs-mcp": {
      "type": "stdio",
      "command": "python",
      "args": ["-m", "mobile_docs_mcp.server"],
      "cwd": "${workspaceFolder}",
      "env": { "MOBILE_DOCS_DATA": "data/android,data/apple" }
    }
  }
}

Open the file and click Start, or run MCP: List Servers from the Command Palette. Copilot Chat's Agent mode will then surface the tools.

Xcode

Xcode 26.3+ is itself an MCP server (it exposes build / test / preview / Apple-doc-search tools) rather than an MCP client — so you don't register mobile-docs-mcp inside Xcode. Instead, run an agent that consumes both: point Claude Code (or Cursor / Codex) at mobile-docs-mcp using the steps above while it's also connected to Xcode's server. The agent then gets Xcode's build/preview tools and this server's verify_api_exists version checks in one session — e.g. it can confirm scrollTargetBehavior needs iOS 17 before writing it against your iOS 16 deployment target, then build the project to check.

Architecture

ingest/  (batch, offline)          server.py  (runtime)
  android.py  developer.android.com   FastMCP
  apple.py    Apple JSON doc API        │
      │                                 ▼
      ▼                             store.py — hybrid, version-aware
  symbols.json + chunks.json          1. BM25 lexical recall
  (version-tagged)                    2. vector recall (optional)
                                      3. RRF fusion
                                      4. VERSION FILTER  ← the differentiator
                                      5. cross-encoder rerank (optional)

Retrieval is provider-agnostic (embeddings.py), same shape as a multi-provider model gateway: BM25 works fully offline; vector recall and rerank switch on via env var with no code change and degrade gracefully if a provider is missing.

MOBILE_DOCS_EMBEDDINGS=local   # or openai ; default none (BM25-only)
MOBILE_DOCS_RERANK=local       # default none
MOBILE_DOCS_DATA=data/android,data/apple   # layer in crawled corpora

Growing the index

python -m mobile_docs_mcp.ingest.android --out data/android \
    --refs androidx.compose.foundation.lazy.LazyColumn \
    --release-notes compose-foundation navigation

python -m mobile_docs_mcp.ingest.apple --out data/apple \
    --paths swiftui/navigationstack swiftui/view/scrolltargetbehavior

Then point the server at the output with MOBILE_DOCS_DATA.

Status

MVP. The protocol layer, version logic, hybrid store, and tool surface are production-shaped; the ingestion coverage is a seed. The real work — and the moat — is breadth and freshness of the version-tagged index.

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mobile_docs_mcp-0.1.0.tar.gz (23.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mobile_docs_mcp-0.1.0-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file mobile_docs_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: mobile_docs_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 23.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for mobile_docs_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 656f86a5e9322df10b4889545dcce1a949d16c0ebfa5192596ec182bd09eb7ed
MD5 e5c1fdafb2a1e04ec901b5c0cd2b9041
BLAKE2b-256 f7b79d730f68695ffddbafee77530fc2190bea536ca05bce4ab4efdf872a8865

See more details on using hashes here.

File details

Details for the file mobile_docs_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mobile_docs_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0e0b82bc489e4671bc3b8893d60160653d8ac91c71bfab93e622855f8405005
MD5 c8e9c7d893177d03fa7131badc047d4c
BLAKE2b-256 6017ede6f8c8fc0cb7bd011f9877a6a7672bca6cabf3085de5d83d0b0f710365

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page