docs: overhaul README with client setup guides and videos#210
Merged
Conversation
…tructure Restructure the README to put Quick Start first, add Claude Code and IBM Bob setup sections with embedded demo videos, make all client configs consistent (all 6 servers), and clean up the overall presentation: strip emoji clutter from sub-headings, collapse secondary content into <details> blocks, replace verbose server listings with compact tables, and rewrite the Architecture section with repo-specific details.
vabarbosa
approved these changes
Apr 21, 2026
Collaborator
There was a problem hiding this comment.
this is great. thank you!!
just two comments:
- should a
## Contributingsection be added to theREADME.mdthat links to theCONTRIBUTING.md(similar to what is in the individual MCP server READMEs) - the
AGENTS.mdshould probably be reviewed as it may also be outdated
… section Rewrote AGENTS.md with accurate tool counts, resources, file paths, and env vars for all six servers. Added Contributing section to README per PR feedback. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Member
Author
|
Good suggestion, applied. Thanks @vabarbosa |
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
mcp_settings.jsonconfig and embedded demo video<details>.movdemo videos to.mp4(7.3MB→1MB, 142MB→14MB) indocs/videos/<details>blockspip install -e .instead of requiringuv