Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: update PROTOCOL.md with complete VS Code tool specs and streamline README #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2025

Conversation

ThomasK33
Copy link
Member

Summary

  • PROTOCOL.md: Added comprehensive specifications for all 12 MCP tools from VS Code extension with complete input/output schemas
  • README.md: Streamlined installation, added Claude Code v1.0.27 compatibility warning, and improved overall readability
  • dev-config.lua: Added new <leader>ab keybind for consistency

Key Changes

PROTOCOL.md Updates

  • Documented all 12 VS Code extension MCP tools with complete Zod schemas
  • Added detailed input/output format examples showing MCP response structure
  • Enhanced tool descriptions with parameter requirements and optional fields
  • Added implementation notes about naming conventions and blocking operations

README.md Improvements

  • Added prominent warning about Claude Code v1.0.27 compatibility issues with GitHub issue links
  • Unified installation configuration (removed simple vs complete setup confusion)
  • Made snacks.nvim a required dependency to reduce support complexity
  • Added <leader>ab keybind for adding current buffer to Claude context
  • Streamlined content flow and reduced verbose sections
  • Updated Key Commands section with line range syntax for ClaudeCodeAdd

dev-config.lua Updates

  • Added <leader>ab keybind to match README configuration

These changes provide complete protocol documentation for developers building integrations while making the README more approachable for quick adoption.

…ine README

- Added comprehensive specifications for all 12 MCP tools from VS Code extension
- Documented complete input/output schemas with Zod validation details
- Added detailed output format examples for each tool showing MCP response structure
- Enhanced tool descriptions with parameter requirements and optional fields
- Added implementation notes about naming conventions and blocking operations

- Added prominent warning about Claude Code v1.0.27 compatibility issues
- Streamlined installation to single unified configuration
- Made snacks.nvim a required dependency to reduce support complexity
- Reorganized content flow: install → demo → usage → advanced config
- Added `<leader>ab` keybind for adding current buffer to Claude context
- Simplified Key Commands section with line range syntax for ClaudeCodeAdd
- Condensed verbose sections while preserving essential information
- Improved overall readability and reduced decision paralysis for users

- Added `<leader>ab` keybind to match README configuration
- Maintained consistency between main README and development config

These changes provide users with complete protocol documentation for building
integrations while making the README more approachable for quick adoption.

Change-Id: I7f30e85c6a4b4c5516fe7a491a9a2f73d2fd497d
Signed-off-by: Thomas Kosiewski <[email protected]>
@ThomasK33 ThomasK33 force-pushed the docs/update-protocol-spec-and-streamline-readme branch from 3599e99 to e7725ea Compare June 20, 2025 12:18
@ThomasK33 ThomasK33 merged commit 3f09b51 into main Jun 20, 2025
3 checks passed
@ThomasK33 ThomasK33 deleted the docs/update-protocol-spec-and-streamline-readme branch June 20, 2025 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant