MCP Standards Server CLI Documentation¶
The MCP Standards Server CLI (mcp-standards
) provides a comprehensive command-line interface for managing, syncing, and querying development standards. This documentation covers all aspects of using the CLI effectively.
Quick Links¶
- Command Reference - Complete reference for all CLI commands
- Getting Started - Quick start guide for new users
- Configuration Guide - Detailed configuration options
- Troubleshooting - Common issues and solutions
- Examples - Real-world usage examples
Overview¶
The MCP Standards Server CLI is designed to:
- Sync Standards: Download and cache standards from GitHub repositories
- Query Standards: Search and retrieve applicable standards based on project context
- Manage Cache: Control local caching of standards files
- Validate Code: Check code against defined standards
- Integration: Work seamlessly with IDEs, CI/CD pipelines, and development workflows
Installation¶
From Source (Currently Available)¶
git clone https://github.com/williamzujkowski/mcp-standards-server
cd mcp-standards-server
pip install -e .
Future Installation Methods¶
Once published to PyPI:
Basic Usage¶
# Sync standards from repository
mcp-standards sync
# Check sync status
mcp-standards status
# Generate a new standard from template
mcp-standards generate --template technical --title "GraphQL Standards"
# Clear cache
mcp-standards cache --clear
# List available templates
mcp-standards generate list-templates
Command Structure¶
The CLI follows a consistent command structure:
Global Options¶
-v, --verbose
: Enable verbose output-c, --config
: Specify configuration file path--no-color
: Disable colored output--json
: Output in JSON format (where applicable)-h, --help
: Show help message
Available Commands¶
sync
: Synchronize standards from repositorystatus
: Show sync status and statisticscache
: Manage local cacheconfig
: Show or validate configurationgenerate
: Generate standards from templateslist-templates
: List available templatestemplate-info
: Get template informationcustomize
: Create custom templatevalidate
: Validate existing standard
Additional Tools¶
The following tools are available through separate entry points:
- MCP Server:
python -m src
- Web UI:
python -m src.web
(if web UI is implemented) - Query Tool: Use the Python API or MCP server for querying standards
Next Steps¶
- Read the Getting Started Guide
- Explore Command Reference
- Learn about Configuration Options
- See Integration Examples