Skip to content

feat(docs): make documentation plugin optional with opt-in config - #413

Merged
navin772 merged 2 commits into
appium:mainfrom
navin772:optional-doc-tool
Jun 19, 2026
Merged

feat(docs): make documentation plugin optional with opt-in config#413
navin772 merged 2 commits into
appium:mainfrom
navin772:optional-doc-tool

Conversation

@navin772

Copy link
Copy Markdown
Member

Everything related to documentation and their cache is now optional so that default install is lightweight and quick to start.

Default behaviour is no doc query and skills tool registration. It is opt in using the env var - APPIUM_MCP_DOCS_ENABLED and manual installation of the @appium/mcp-documentation package.

If APPIUM_MCP_DOCS_ENABLED is set and manual installation is not done then a helpful msg is logged:

WARN appium-mcp APPIUM_MCP_DOCS_ENABLED is set but @appium/mcp-documentation is not installed. The documentation tools (appium_documentation_query, appium_skills) will be unavailable. Install the package to enable them:
WARN appium-mcp   npm install @appium/mcp-documentation

@KazuCocoa KazuCocoa left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments, otherwise lg.

Actually, I missed to move the documentation deps into optional...

Comment thread src/documentation.ts
Comment thread package.json
@navin772
navin772 merged commit 21d709f into appium:main Jun 19, 2026
5 checks passed
@navin772
navin772 deleted the optional-doc-tool branch June 19, 2026 06:17
github-actions Bot pushed a commit that referenced this pull request Jun 19, 2026
## [1.86.0](v1.85.10...v1.86.0) (2026-06-19)

### Features

* **docs:** make documentation plugin optional with opt-in config ([#413](#413)) ([21d709f](21d709f))
@github-actions

Copy link
Copy Markdown

🎉 This PR is included in version 1.86.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants