DOC-6268 infra to map command names to client API calls and display in docs#2799
Merged
andy-stark-redis merged 63 commits intomainfrom Feb 27, 2026
Merged
DOC-6268 infra to map command names to client API calls and display in docs#2799andy-stark-redis merged 63 commits intomainfrom
andy-stark-redis merged 63 commits intomainfrom
Conversation
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| @@ -0,0 +1 @@ | |||
| # Augment MCP Server Integration Guide\n\n## Current Status\n\n✅ **Server is fully functional and tested**\n- All 6 tools are discoverable\n- All tools respond correctly to invocations\n- Server builds without errors\n- Server starts without errors\n\n⏳ **Augment Integration Issue**\n- Augment shows red pip: \"No tools are available for this MCP server\"\n- This indicates Augment IS connecting but server isn't responding to ListTools\n\n## Configuration Options\n\nTry these configurations in order:\n\n### Option 1: Simple (Recommended)\n```json\n{\n \"mcpServers\": {\n \"redis-parser-mcp\": {\n \"command\": \"node\",\n \"args\": [\"/Users/andrew.stark/Documents/Repos/docs/build/command_api_mapping/mcp-server/node/dist/index.js\"]\n }\n }\n}\n```\n\n### Option 2: With CWD\n```json\n{\n \"mcpServers\": {\n \"redis-parser-mcp\": {\n \"command\": \"node\",\n \"args\": [\"dist/index.js\"],\n \"cwd\": \"/Users/andrew.stark/Documents/Repos/docs/build/command_api_mapping/mcp-server\"\n }\n }\n}\n```\n\n### Option 3: Full Path to Node\n```json\n{\n \"mcpServers\": {\n \"redis-parser-mcp\": {\n \"command\": \"/usr/local/bin/node\",\n \"args\": [\"dist/index.js\"],\n \"cwd\": \"/Users/andrew.stark/Documents/Repos/docs/build/command_api_mapping/mcp-server\"\n }\n }\n}\n```\n\n## Troubleshooting Steps\n\n1. **Remove and re-add the server**\n - Go to Augment Settings\n - Remove the redis-parser-mcp server\n - Close VSCode completely\n - Reopen VSCode\n - Re-add the server with one of the configs above\n\n2. **Check if Augment daemon needs restart**\n - Run: `ps aux | grep -i augment | grep -v grep`\n - If there's an Augment process, try killing it\n - Restart VSCode\n\n3. **Verify server works manually**\n ```bash\n cd /Users/andrew.stark/Documents/Repos/docs/build/command_api_mapping/mcp-server\n node node/dist/index.js\n ```\n Should start without errors and wait for connections.\n\n4. **Test tool discovery**\n ```bash\n cd /Users/andrew.stark/Documents/Repos/docs/build/command_api_mapping/mcp-server/node\n npm run test-augment-discovery\n ```\n Should show all 6 tools are discoverable.\n\n## Available Tools\n\nOnce Augment connects, these tools will be available:\n\n1. **list_redis_commands** - List all Redis commands\n2. **list_clients** - List all supported Redis clients \n3. **get_client_info** - Get information about a specific client\n4. **extract_signatures** - Extract method signatures from source files\n5. **extract_doc_comments** - Extract documentation from code\n6. **validate_signature** - Validate method signatures\n\n## Files Modified\n\n- `node/package.json` - Added `\"type\": \"module\"`\n- `node/src/index.ts` - Fixed imports and removed startup messages\n- `node/src/data/data-access.ts` - Fixed imports\n- `node/src/data/components-access.ts` - Fixed imports\n- `node/src/test-wasm.ts` - Fixed imports\n- `node/src/integration-test.ts` - Fixed imports\n\n## Next Steps\n\n1. Try one of the configuration options above\n2. Remove and re-add the server in Augment Settings\n3. Close and reopen VSCode\n4. Check if tools now appear\n5. If still not working, try the other configuration options\n" | |||
There was a problem hiding this comment.
Hardcoded personal paths leak developer home directory
Medium Severity
Multiple files contain hardcoded absolute paths referencing a developer's local machine: /Users/andrew.stark/Documents/Repos/docs/.... This appears in AUGMENT_INTEGRATION_GUIDE.md, AUGMENT_INTEGRATION_SUCCESS.md, AUGMENT_QUICK_START.md, and MCP_SERVER_STATUS.md. These paths expose the developer's username and local directory structure, and won't work for any other team member.
Additional Locations (2)
dwdougherty
approved these changes
Feb 27, 2026
Collaborator
dwdougherty
left a comment
dwdougherty
left a comment
There was a problem hiding this comment.
Cool stuff, @andy-stark-redis. Approved.
Contributor
Author
|
@dwdougherty Thanks for the review! Great to finally get this into action :-) |
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.
Some sample pages:
SETcommand pageA few main components to this:
command-api-mapping.jsonfile to represent the mapping between client method signatures and corresponding commands. This includes parameter/return details and descriptions where available. Note that only a small test subset of this info is currently in place.The MCP server isn't worth looking at unless you are particularly interested. The method signatures are implemented for the string and hash data type pages and command page (so
SET,HGET, etc).All feedback is welcome, but I'm well aware that there is still a lot to do on this! At this stage, I'm mainly just checking in to see if everyone is OK with where this is going so far.
Note
Low Risk
Low risk: this PR adds/updates documentation and project planning artifacts only, with no functional code or production configuration changes in the diff.
Overview
Adds a large set of new documentation for the Redis command→client API mapping effort, including the
data/command-api-mapping/JSON file structure and merge workflow.Documents the proposed/implemented MCP-server-based extraction architecture and Augment integration (tool list, troubleshooting, and confirmed working configuration), plus project status artifacts (milestone plans/completions, testing summaries, extraction summaries, and a production deployment guide).
Written by Cursor Bugbot for commit b35c1b9. This will update automatically on new commits. Configure here.