Restructure MCP site with full documentation content#175
Open
adityamparikh wants to merge 12 commits into
Open
Restructure MCP site with full documentation content#175adityamparikh wants to merge 12 commits into
adityamparikh wants to merge 12 commits into
Conversation
Rewrite the MCP subproject website to contain actual usage content instead of just linking to GitHub, following the SonarQube MCP Server docs pattern. New pages: - Quick Start: step-by-step from zero to working integration - Per-client setup pages (one page each): Claude Desktop, Claude Code, VS Code/Copilot, Cursor, JetBrains, MCP Inspector Each with STDIO and HTTP mode configs. - Security: OAuth2 setup with Auth0 and Keycloak - Observability: LGTM stack traces, metrics, and logs - Resources: documentation links and references Updated pages: - Features: replaced generic cards with tool reference tables, MCP resources table, environment variables reference - Index: added Quick Start and Clients to Next Steps section - Header: added Quick Start, Clients, Resources nav items - Footer: reorganized into Features, Get Started, Resources, Community columns with links to all new pages Fixes: - DOAP: programming-language Go -> Java, category go -> java - pelicanconf: version v0.0.0 -> v1.0.0 Signed-off-by: Aditya Parikh <[email protected]> Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: adityamparikh <[email protected]>
2 tasks
Reorder all client configs to show JAR setup first (ATR release path) and local Docker images second. Remove all ghcr.io references — use solr-mcp:latest built locally via ./gradlew jibDockerBuild. Applies to: quick-start, all 6 client pages, security page. Signed-off-by: Aditya Parikh <[email protected]> Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: adityamparikh <[email protected]>
- quick-start: #start-solr -> #start-solr-with-sample-data, etc. - security: #how-oauth2-works -> #how-oauth2-works-with-mcp-clients - observability: #actuator -> #actuator-endpoints, #production -> #production-configuration - community: remove #powered-by (no matching heading) Signed-off-by: Aditya Parikh <[email protected]> Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: adityamparikh <[email protected]>
Update GitHub links from dev-docs/ and security-docs/ to the new docs/development/ paths in resources and security pages. Signed-off-by: Aditya Parikh <[email protected]> Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: adityamparikh <[email protected]>
- _head.html: fix stray space in license URL (LICENSE- 2.0 -> LICENSE-2.0) - downloads.html: remove incorrect "incubating" language, link to README - mcp-inspector.md: reorder STDIO before HTTP for consistency Signed-off-by: Aditya Parikh <[email protected]> Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> Signed-off-by: adityamparikh <[email protected]>
Document the GraalVM native image build path on the MCP quick-start page. Spring Boot's bootBuildImage produces an opt-in native image for the STDIO profile that starts in milliseconds and uses substantially less memory than the JVM Jib image. Note that the native image is AOT-locked to the STDIO profile (Spring Boot bakes a profile-specific bean graph at build time, so a single native image cannot serve both transports). HTTP deployments use the JVM Jib image; native HTTP support is a future enhancement. Signed-off-by: Aditya Parikh <[email protected]> Signed-off-by: adityamparikh <[email protected]>
apache/solr-mcp now ships two native image variants instead of just one: solr-mcp:<v>-native-stdio (built via `bootBuildImage -Pnative`) and solr-mcp:<v>-native-http (`bootBuildImage -Pnative -Pprofile=http`). Each is AOT-pinned to a single transport because Spring AOT bakes the web-application-type into the binary. The previous text said HTTP transport was JVM-only and called native HTTP support a future enhancement. Both claims are now stale — verified end-to-end via DockerImageMcpClientStdioIntegrationTest in apache/solr-mcp. Updates: - Mention both stdio and http native variants - Show `-Pnative -Pprofile=stdio|http` build commands - Update tag suffix from `-native` to `-native-stdio` / `-native-http` - Reframe the trade-off: single Jib JVM image is dual-transport, native variants are single-transport per AOT pin Signed-off-by: adityamparikh <[email protected]>
3 tasks
- Bump hero subhead from "9 tools and 2 resources" to "11 tools, 6
prompts, and 2 resources" to reflect the expanded surface.
- Schema table: add add-fields and add-field-types rows (additive
schema modification via Solr Schema API).
- Add a paragraph below the Tool Reference noting MCP behavior hints
(readOnlyHint / destructiveHint / idempotentHint) so client
integrators know to read them.
- Clarify that solr://{collection}/schema autocompletion is
prefix-filtered, case-insensitive, and capped at 100 suggestions.
- New "MCP Prompts" section listing the six workflow templates:
explore-collections, setup-collection, view-schema, design-schema,
index-data, search-collection.
Companion to apache/solr-mcp PRs apache#131, apache#134, and the upcoming prompts
and completion PRs landing at apache/solr-mcp.
Signed-off-by: adityamparikh <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the MCP subproject website from a thin link-hub into a full documentation site with actual usage content, following the SonarQube MCP Server docs pattern.
New pages
Updated pages
Fixes
programming-languageGo → Java, categorygo→javapelicanconf.py: versionv0.0.0→v1.0.0Depends on #160 (should be merged after that PR). Supersedes #174.
Companion to apache/solr-mcp#95 (README/CONTRIBUTING restructure).
Test plan
./bin/solr-site buildpasses without errors (after merging SOLR-17992 First version of MCP web site #160)🤖 Generated with Claude Code