Contributing

Elasticsearch MCP Server client is open source and we love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code.

Contributions are released under the project's license.

Please note that this project follows the Elastic's Open Source Community Code of Conduct.

Setup

Install Node.js 18+ (using nvm is recommended)
```
nvm use
```
Install dependencies
```
npm install
```
Build the project
```
npm run build
```

Start Elasticsearch

You can use either:

Elastic Cloud - Use an existing Elasticsearch deployment and your API key
Local Elasticsearch - Run Elasticsearch locally using the start-local script:
```
curl -fsSL https://elastic.co/start-local | sh
```
This starts Elasticsearch and Kibana with Docker:
- Elasticsearch: http://localhost:9200
- Kibana: http://localhost:5601

Note

The start-local setup is for development only. It uses basic authentication and disables HTTPS.

Development Workflow

Fork and clone the repository
Create a new branch: git checkout -b my-branch-name
Make your changes

Test locally with the MCP Inspector:

ES_URL=your-elasticsearch-url ES_API_KEY=your-api-key npm run inspector

Test with MCP Client
Push to your fork and submit a pull request

Best Practices

Follow existing code style and patterns
Write conventional commits
Include tests for your changes
Keep PRs focused on a single concern
Update documentation as needed
Use TypeScript with proper typing
Add JSDoc comments to new functions

Getting Help

Open an issue in the repository
Ask questions on discuss.elastic.co

Resources

How to Contribute to Open Source
Using Pull Requests
Elastic Code of Conduct

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!