|
| 1 | +# Contributing to GrowthBook MCP Server |
| 2 | + |
| 3 | +Thank you for your interest in contributing! Follow these steps to work locally and test your changes: |
| 4 | + |
| 5 | +## Local Development Setup |
| 6 | + |
| 7 | +1. **Clone the repository** |
| 8 | + |
| 9 | + ```sh |
| 10 | + git clone https://github.com/YOUR_USERNAME/growthbook-mcp.git |
| 11 | + cd growthbook-mcp |
| 12 | + ``` |
| 13 | + |
| 14 | +2. **Install dependencies** |
| 15 | + |
| 16 | + ```sh |
| 17 | + pnpm install |
| 18 | + ``` |
| 19 | + |
| 20 | +3. **Build the project** |
| 21 | + |
| 22 | + Use TypeScript to generate the build: |
| 23 | + |
| 24 | + ```sh |
| 25 | + npx tsc |
| 26 | + ``` |
| 27 | + |
| 28 | + This will output the compiled JavaScript files to the `dist/` directory (or as configured in `tsconfig.json`). |
| 29 | + |
| 30 | +4. **Add the server to your AI tool** |
| 31 | + |
| 32 | +When configuring your MCP client (e.g., Cursor, VS Code, Claude Desktop), use the absolute path to your local build. Example JSON config: |
| 33 | + |
| 34 | + ```json |
| 35 | + { |
| 36 | + "mcpServers": { |
| 37 | + "growthbook": { |
| 38 | + "command": "node", |
| 39 | + "args": ["/absolute/path/to/growthbook-mcp/dist/index.js"], |
| 40 | + "env": { |
| 41 | + "GB_API_KEY": "your-api-key", |
| 42 | + "GB_USER": "your-name", |
| 43 | + "GB_API_URL": "your-api-url", |
| 44 | + "GB_APP_ORIGIN": "your-app-origin" |
| 45 | + } |
| 46 | + } |
| 47 | + } |
| 48 | + } |
| 49 | + ``` |
| 50 | + |
| 51 | +Replace `/absolute/path/to/growthbook-mcp/dist/index.js` with the actual path on your machine. If you're testing with a local version of GrowthBook, be sure to update environment variables to point to your local install. |
| 52 | + |
| 53 | +GrowthBook MCP is now ready to use 🤖 |
| 54 | + |
| 55 | +## Testing Changes |
| 56 | + |
| 57 | +- After making code changes, re-run `npx tsc` to rebuild. |
| 58 | +- Restart the server to pick up your changes. |
| 59 | + |
| 60 | +## Submitting Pull Requests |
| 61 | + |
| 62 | +1. Fork the repository and create your branch. |
| 63 | +2. Make your changes and commit with clear messages. |
| 64 | +3. Ensure your code is linted and built successfully. |
| 65 | +4. Open a pull request with a description of your changes. |
| 66 | + |
| 67 | +--- |
| 68 | + |
| 69 | +For more details on client integration and available tools, see the [README.md](./README.md). |
| 70 | + |
| 71 | +--- |
| 72 | + |
| 73 | +## Bonus: Use the MCP Inspector 🚀 |
| 74 | + |
| 75 | +For a better development and debugging experience, try the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) to test tools and more. |
0 commit comments