Skip to content

Add website, community links, and ref-guide pointer to README #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adityamparikh wants to merge 1 commit into from
Closed

Add website, community links, and ref-guide pointer to README #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

A Spring AI Model Context Protocol (MCP) server that provides tools for interacting with Apache Solr. Enables AI assistants like Claude to search, index, and manage Solr collections through the MCP protocol.

**Website:** https://solr.apache.org/mcp | **User Guide:** [Solr Reference Guide Tutorial](https://solr.apache.org/guide/solr/latest/getting-started/tutorial-solr-mcp.html)

## What's inside

- 🔍 Search Solr collections with filtering, faceting, and pagination
Expand Down Expand Up @@ -412,20 +414,24 @@ See [docs/specs/graalvm-native-image.md](docs/specs/graalvm-native-image.md) for

## Documentation

- [User Guide (Solr Reference Guide)](https://solr.apache.org/guide/solr/latest/getting-started/tutorial-solr-mcp.html) -- comprehensive tutorial covering all transport modes, client integrations, security, and observability
Copy link
Copy Markdown

@janhoy janhoy Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure a comprehensive documentation of the MCP tool belongs in the reference guide for Solr? We have discussed this elsewhere too but I have not seen any consensus.

- [Auth0 Setup (OAuth2 configuration)](security-docs/AUTH0_SETUP.md)
- [GraalVM native image spec](docs/specs/graalvm-native-image.md)

## Community

- **Website:** https://solr.apache.org/mcp
- **Slack:** [`#solr-mcp`](https://the-asf.slack.com/archives/C09TVG3BM1P) in the `the-asf` Slack workspace
- **Mailing lists:** Shared with Apache Solr -- see [mailing lists](https://solr.apache.org/community.html#mailing-lists-chat)
- **Issues:** https://github.com/apache/solr-mcp/issues
- **Discussions:** https://github.com/apache/solr-mcp/discussions

## Contributing

We welcome contributions!

- Start here: [CONTRIBUTING.md](CONTRIBUTING.md)

## Support

- Issues: https://github.com/apache/solr-mcp/issues
- Discussions: https://github.com/apache/solr-mcp/discussions

## License

Apache License 2.0 — see LICENSE
Expand Down