Revise README with detailed Couchbase MCP Server info - #239
Merged
Conversation
Updated README to include detailed information about Couchbase MCP Server, its features, and usage instructions. Added a Table of Contents and expanded sections on safety, compatibility, and natural language querying.
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the README to better explain what the Couchbase MCP Server is, how it’s used with MCP clients, and to add navigation/help sections for users.
Changes:
- Expanded the introduction with a clearer MCP-focused description and a documentation link.
- Added a Table of Contents and “Why” + “Example Prompts” sections for easier onboarding.
- Added an FAQ section to address common setup and usage questions.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
VirajAgarwal-couchbase
requested changes
Aug 19, 2026
VirajAgarwal-couchbase
left a comment
VirajAgarwal-couchbase
left a comment
Contributor
There was a problem hiding this comment.
Thanks for PR!
VirajAgarwal-couchbase
approved these changes
Aug 27, 2026
VirajAgarwal-couchbase
left a comment
VirajAgarwal-couchbase
left a comment
Contributor
There was a problem hiding this comment.
lgtm. Thanks for the PR 😁! And sorry it got delayed due to my poor memory 😅
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
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.
Updated README to include detailed information about Couchbase MCP Server, its features, and usage instructions. Added a Table of Contents and expanded sections on safety, compatibility, and natural language querying.
Related Issue
n/a
Resolves:
What does this change do?
Improves copy for MCP readme
Why is this change needed?
Improve discoverability, SEO, GEO
Evidence of Testing
n/a
Environments tested (both are required):
n/a
Manual verification — MCP client used (Claude Desktop, Cursor, MCP Inspector, ...) and what was exercised. Screenshots or tool-call transcripts are very helpful:
local editor
Compatibility Considerations
n/a
Checklist
n/a
cb_mcp.corecontracts / managed MCP interfaces (or discussed first)