{"id":51339989,"url":"https://github.com/appium/appium-mcp-documentation","last_synced_at":"2026-07-02T06:33:16.843Z","repository":{"id":363009357,"uuid":"1260090077","full_name":"appium/appium-mcp-documentation","owner":"appium","description":null,"archived":false,"fork":false,"pushed_at":"2026-06-14T02:40:46.000Z","size":518,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-14T04:19:17.906Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appium.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"open_collective":"appium"}},"created_at":"2026-06-05T06:33:53.000Z","updated_at":"2026-06-14T02:40:47.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/appium/appium-mcp-documentation","commit_stats":null,"previous_names":["appium/appium-mcp-documentation"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/appium/appium-mcp-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appium%2Fappium-mcp-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appium%2Fappium-mcp-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appium%2Fappium-mcp-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appium%2Fappium-mcp-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appium","download_url":"https://codeload.github.com/appium/appium-mcp-documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appium%2Fappium-mcp-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35036553,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-02T02:00:06.368Z","response_time":173,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-07-02T06:33:11.213Z","updated_at":"2026-07-02T06:33:16.820Z","avatar_url":"https://github.com/appium.png","language":"TypeScript","funding_links":["https://opencollective.com/appium"],"categories":[],"sub_categories":[],"readme":"# @appium/mcp-documentation\n\nAppium MCP documentation query tools and indexed documentation assets.\n\nThis package provides an Appium documentation plugin for MCP servers. It exposes\ntools that can answer Appium documentation questions and return ordered setup or\ntroubleshooting guidance from the vendored Appium skills content.\n\n## Tools\n\n- `appium_documentation_query`: queries indexed Appium documentation with RAG.\n- `appium_skills`: returns ordered Appium setup or troubleshooting skills for\n  Android and iOS local environments.\n\n## Use With appium-mcp\n\nInstall this package alongside `appium-mcp` in the server project that starts\nyour MCP server.\n\n```bash\nnpm install appium-mcp\nnpm install @appium/mcp-documentation\n```\n\nWhen developing against a local checkout, build this package first and install\nit by path from the appium-mcp server project:\n\n```bash\ncd /path/to/appium-mcp-documentation\nnpm install\nnpm run build\n\ncd /path/to/your-appium-mcp-server\nnpm install /path/to/appium-mcp-documentation\n```\n\nRegister the documentation plugin when creating the Appium MCP server:\n\n```ts\nimport { createAppiumMcpServer } from 'appium-mcp/core';\nimport { AppiumDocumentation } from '@appium/mcp-documentation';\n\nconst server = createAppiumMcpServer({\n  plugins: [new AppiumDocumentation()],\n});\n\nawait server.start({\n  transportType: 'stdio',\n});\n```\n\nFor HTTP stream transport:\n\n```ts\nawait server.start({\n  transportType: 'httpStream',\n  httpStream: {\n    endpoint: '/sse',\n    port: 8080,\n  },\n});\n```\n\nOnce registered, the Appium MCP server exposes the normal Appium automation\ntools plus `appium_documentation_query` and `appium_skills`.\n\nNote that the default appium-mcp server enables the documentation plugin if available, so you may not need to explicitly register it.\n\n## Direct API\n\nYou can also use the documentation query API directly:\n\n```ts\nimport {\n  answerAppiumQuery,\n  initializeAppiumDocumentation,\n} from '@appium/mcp-documentation';\n\nawait initializeAppiumDocumentation();\n\nconst result = await answerAppiumQuery({\n  query: 'How do I configure UiAutomator2 capabilities?',\n});\n\nconsole.log(result.answer);\n```\n\n## Development\n\nInstall dependencies:\n\n```bash\nnpm install\n```\n\nBuild the package:\n\n```bash\nnpm run build\n```\n\nRun tests and lint:\n\n```bash\nnpm test\nnpm run lint\n```\n\nRebuild the documentation index:\n\n```bash\nnpm run build\nnpm run index-docs\n```\n\nQuery the built index from the command line:\n\n```bash\nnpm run query-docs -- \"How do I start an Appium session?\"\n```\n\n## Dependency Notes\n\nThe runtime dependencies are the packages used by the shipped tools and RAG\nimplementation. `fastmcp` is a development dependency here because this package\nonly imports its types.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappium%2Fappium-mcp-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappium%2Fappium-mcp-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappium%2Fappium-mcp-documentation/lists"}