mcp-server-db2i

# Contributing to mcp-server-db2i Thank you for your interest in contributing! This document provides guidelines and instructions for contributing. ## Getting Started 1. **Fork the repository** and clone your fork 2. **Install dependencies:** ```bash npm install ``` 3. **Build the project:** ```bash npm run build ``` 4. **Set up environment** (for testing): ```bash cp .env.example .env # Edit .env with your IBM i credentials ``` ## Development Workflow ### Making Changes 1. Create a feature branch from `main`: ```bash git checkout -b feat/your-feature-name ``` 2. Make your changes and ensure the project builds: ```bash npm run build ``` 3. Test your changes with the MCP Inspector: ```bash npx @modelcontextprotocol/inspector node dist/index.js ``` ### Commit Messages We use [Conventional Commits](https://www.conventionalcommits.org/) for automated releases: | Type | Description | Version Bump | |------|-------------|--------------| | `feat:` | New feature | Minor | | `fix:` | Bug fix | Patch | | `docs:` | Documentation only | None | | `chore:` | Maintenance | None | | `feat!:` | Breaking change | Major | Examples: ``` feat: add list_procedures tool fix: handle null values in query results docs: update JDBC options table ``` ### Pull Requests 1. Push your branch to your fork 2. Open a PR against `main` 3. Fill out the PR template 4. Ensure CI passes (build check) 5. Request review ## Project Structure ``` src/ ├── index.ts # MCP server setup and tool registration ├── config.ts # Configuration loading ├── db/ │ ├── connection.ts # Database connection management │ └── queries.ts # SQL query functions └── tools/ ├── query.ts # Query execution tool └── metadata.ts # Schema/table inspection tools ``` ## Adding New Tools 1. Add the query function in `src/db/queries.ts` 2. Add the tool wrapper in `src/tools/` (query or metadata) 3. Register the tool in `src/index.ts` 4. Update `README.md` with the new tool ## Code Style - Use TypeScript strict mode - Prefer `async/await` over raw promises - Add JSDoc comments for public functions - Keep tools focused and single-purpose ## Questions? Open an issue for questions or discussion. We're happy to help!