quality-mcp
Version:
An MCP server that analyzes to your codebase, with plugin support for DCD and Simian. šļø "The only Zen you find on the tops of mountains is the Zen you bring up there."
108 lines (77 loc) ⢠2.01 kB
Markdown
# Development Guide
## Quick Start
```bash
# Install dependencies
npm install
# Setup DCD (recommended)
npm run setup-dcd
# Run tests
npm test
# Start development server
npm run dev
```
## Project Structure
```
src/
āāā index.js # MCP server entry point
āāā core/ # Core functionality
āāā plugins/ # Analysis tool plugins
ā āāā dcd/ # DCD integration
ā āāā simian/ # Simian integration
āāā utils/ # Utilities
```
## Testing
```bash
# Run all tests
npm test
# Test DCD integration
npm run test:dcd
# Run with coverage
npm run test:coverage
# Run specific test file
npm test test/plugins/dcd/index.test.js
# Run tests with verbose output
npm test -- --verbose
# Run tests in watch mode
npm test -- --watch
```
### Test Categories
- **Unit Tests**: Plugin definitions, tool validation, configuration
- **Integration Tests**: MCP server integration, tool execution
- **Manual Testing**: Real MCP client testing, performance validation
### Testing with Real Tools
```bash
# DCD Testing
dcd --version
npm run test:dcd
# Simian Testing
export SIMIAN_EXECUTABLE=/path/to/simian.jar
npm run test:simian
# Mock Mode (no external tools needed)
export SIMIAN_MOCK_MODE=true
export DCD_MOCK_MODE=true
npm test
```
## Configuration
### Environment Variables
```bash
# DCD (recommended)
DCD_EXECUTABLE=dcd
# Simian (commercial)
SIMIAN_EXECUTABLE=/path/to/simian.jar
# Development
LOG_LEVEL=debug
SIMIAN_MOCK_MODE=true
```
## Architecture
- **Plugin System**: Extensible architecture for analysis tools
- **MCP Integration**: Full Model Context Protocol support
- **Caching**: File-based cache for performance
- **Mock Mode**: Development without external tools
## Contributing
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request
See [contributing.md](contributing.md) for detailed guidelines and quality standards.