Contributing

Development Setup

1. Fork and clone the repository:

   git clone https://github.com/YOUR_USERNAME/android-pilot-mcp.git
   cd android-pilot-mcp

2. Install dependencies:

   npm install

3. Build the project:

   npm run build

4. Run tests:

   npm test

Project Scripts

Script	Purpose
npm run build	Compile TypeScript and copy templates
npm run dev	Watch mode for development
npm test	Run tests with Vitest
npm run lint	Run ESLint
npm run format	Format code with Prettier
npm run typecheck	Type check without emitting
npm run check	Run typecheck + lint + format check

Adding a New Tool

1. Define the tool in the appropriate file under src/tools/. Follow existing patterns for parameter schemas using Zod.

2. Register the tool in src/index.ts by adding it to the tool list.

3. Add tests in the tests/ directory. All tools should have unit tests.

4. Update documentation — add a new MDX page in docs/src/content/docs/tools/.

5. Run the full check suite:

   npm run check && npm test

Coding Standards

• TypeScript strict mode
• ESLint + Prettier for formatting
• All exports must have JSDoc comments
• Use Zod for input validation
• Prefer async/await over callbacks

Tip

Pre-commit hooks (via Husky) automatically run ESLint and Prettier on staged files.