@dotted-labs/ai-vibecontext
v0.0.10
Published
VibeContext Application for documentation management
Maintainers
Readme
@dotted-labs/ai-vibecontext
VibeContext MCP Server - A Model Context Protocol server for AI-powered documentation management.
Features
🔧 4 Essential Tools:
- readDoc: Read documentation files
- writeDoc: Create/edit documentation files
- listTentatives: List pending *.vc.md files
- readCodeDiff: Get git diffs for code analysis
🛡️ Security First:
- Sandboxed file access (repository only)
- Path traversal protection
- Allowed file extensions validation
- Standard MCP protocol compliance
🚀 Easy Integration:
- Works with Cursor IDE
- Compatible with Claude Desktop
- Standard MCP protocol (JSON-RPC 2.0)
- TypeScript support included
Installation
npm install -g @dotted-labs/ai-vibecontext
Quick Start
1. Configuration
Create or update your .cursor/mcp.json:
{
"mcpServers": {
"vibecontext": {
"command": "vibecontext-mcp",
"env": {
"OPENAI_API_KEY": "your-api-key-optional"
}
}
}
}2. Usage
Once configured, the tools are available in your MCP-compatible client:
// Read a documentation file
readDoc({ path: 'docs/README.md' });
// Write documentation
writeDoc({
path: 'docs/feature.md',
content: '# New Feature\n\nDescription...',
});
// List tentative files
listTentatives();
// Get code diff
readCodeDiff({ filePath: 'src/app.ts' });Tools Reference
readDoc(params)
Reads content from documentation files.
Parameters:
path(string): Relative path to file
Returns: File content as string
writeDoc(params)
Creates or overwrites documentation files.
Parameters:
path(string): Relative path for the filecontent(string): File content
Returns: Success message
listTentatives()
Lists all *.vc.md files in .vibecontext/tentative/ directory.
Returns: Array of tentative files with metadata
readCodeDiff(params)
Gets git diff for a specific file against HEAD.
Parameters:
filePath(string): Path to file for diff
Returns: Git diff output
Security
- Sandboxed Access: Only files within the current repository
- Allowed Extensions:
.md,.vc.md,.txtonly - Path Validation: Prevents directory traversal attacks
- Standard Protocol: Uses official MCP specification
Development
Local Setup
# Clone the repository
git clone https://github.com/luisMDev/vibe-context.git
cd vibe-context/packages/mcp
# Install dependencies
npm install
# Build
npm run build
# Run locally
npm startContributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
License
MIT © Luis M. (@luisMDev)
Links
Changelog
1.0.0
- Initial release
- Core MCP tools implementation
- Security sandbox
- TypeScript support
- Standard MCP protocol compliance
