Vega-Lite MCP Server

# Contributing to Vega-Lite MCP Server Thank you for your interest in contributing! This document provides guidelines for contributing to the project. ## Development Setup 1. **Fork and clone the repository** ```bash git clone https://github.com/yourusername/vegalite-mcp-server.git cd vegalite-mcp-server ``` 2. **Install dependencies** ```bash npm install ``` 3. **Build the project** ```bash npm run build ``` 4. **Run in development mode** ```bash npm run watch ``` ## Project Structure ``` src/ ├── index.ts # Main server entry point ├── tools/ # Tool implementations │ ├── search.ts # Documentation search │ ├── examples.ts # Example retrieval │ └── validate.ts # Spec validation ├── utils/ # Utilities │ └── scraper.ts # Documentation scraper └── data/ # Scraped data (generated) ``` ## Adding New Tools To add a new tool to the MCP server: 1. **Create the tool implementation** in `src/tools/` ```typescript export async function myNewTool(param: string): Promise<Result> { // Implementation } ``` 2. **Register the tool** in `src/index.ts`: - Add it to the `ListToolsRequestSchema` handler - Add a case in the `CallToolRequestSchema` handler 3. **Update documentation** in README.md ## Improving Documentation Search The documentation scraper (`src/utils/scraper.ts`) can be enhanced: - Add more pages to the `DOC_PAGES` array - Improve content extraction logic - Add support for code examples - Implement semantic search with embeddings ## Testing Before submitting a PR: 1. Build the project: `npm run build` 2. Test with Claude Desktop or VS Code 3. Verify all tools work correctly ## Code Style - Use TypeScript strict mode - Follow existing code formatting - Add JSDoc comments for public functions - Use meaningful variable names ## Commit Messages Use clear, descriptive commit messages: - `feat:` for new features - `fix:` for bug fixes - `docs:` for documentation changes - `refactor:` for code refactoring ## Pull Request Process 1. Create a feature branch from `main` 2. Make your changes 3. Update documentation if needed 4. Submit a PR with a clear description ## Questions? Open an issue for: - Bug reports - Feature requests - Questions about the codebase Thank you for contributing!