Skip to content

Add Solr MCP Server tutorial to reference guide#4043

Closed
adityamparikh wants to merge 2 commits intoapache:mainfrom
adityamparikh:solr-mcp
Closed

Add Solr MCP Server tutorial to reference guide#4043
adityamparikh wants to merge 2 commits intoapache:mainfrom
adityamparikh:solr-mcp

Conversation

@adityamparikh
Copy link
Copy Markdown

@adityamparikh adityamparikh commented Jan 11, 2026

Summary

  • Add a new tutorial for the Solr MCP Server that enables AI assistants like Claude to interact with Apache Solr via the Model Context Protocol (MCP)
  • Tutorial covers STDIO and HTTP transport modes with Docker and source-based deployment options
  • Includes Claude Desktop integration examples and OAuth2 security configuration

Tutorial Contents

  • What is MCP? - Introduction with link to MCP specification
  • Features - MCP tools (search, index_documents, listCollections, etc.) and resources
  • STDIO Mode - Docker and build-from-source instructions with Claude Desktop config
  • HTTP Mode - Docker and build-from-source instructions with security notes
  • Environment Variables - Reference table for configuration options
  • Example Usage - Sample queries users can try with Claude

Test plan

  • ./gradlew buildLocalSite passes without errors
  • Review rendered tutorial in generated site

🤖 Generated with Claude Code

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jan 11, 2026
@epugh
Copy link
Copy Markdown
Contributor

epugh commented Feb 4, 2026

Notes to Eric:

  • Focus on the Jar running (and yes, java 25, but come on folks!), not the docker until we get that deployed porperly.
  • Move all the stuff below the STDIO versu HTTP into the github.com/apache/solr-mcp repo to live. Keep the tutorial as a short tutorial! No reference in the tutorial.

Adds a comprehensive user guide for the Solr MCP Server covering quick
start, MCP client integration (Claude Desktop, Claude Code, VS Code,
Cursor, JetBrains), STDIO and HTTP transport modes, OAuth2 security
with Auth0 and Keycloak, observability with the LGTM stack, building
from source, and debugging with MCP Inspector.

Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
@epugh
Copy link
Copy Markdown
Contributor

epugh commented Apr 23, 2026

In looking at the outline, let's keep sections 1, 2, 3, 4, 5 and 6 in the Ref Guide. Let's move 7, 8 into the solr-mcp project dev docs. I think 9 can stay in the Ref Guide, it may be too opinonated on one solution, but lets see. 10 should be in Dev Docs. 11 should just be merged into solr-mcp/CONTRIBUTING.md file. 12 should be in Dev Docs.

- Add TIP block near the top linking to solr.apache.org/mcp and
  the GitHub repo
- Add Community section with website, Slack (#solr-mcp), mailing
  lists, and issue tracker links
- Add website to References section

Signed-off-by: Aditya Parikh <adityamparikh@gmail.com>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: adityamparikh <aditya.m.parikh@gmail.com>
@adityamparikh
Copy link
Copy Markdown
Author

Closing in favor of the website documentation at solr.apache.org/mcp. The content from this tutorial has been restructured into dedicated pages on the Solr MCP Server website (apache/solr-site#175): quick start, per-client setup guides, security, observability, features, and resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants