# Example Setup
A complete example of an instruction-mcp server with project workflows and code review checklists.
## Quick Start
### 1. Validate the config
```bash
npx instruction-mcp validate -c instruction.yaml
```
### 2. List available tools
```bash
npx instruction-mcp list -c instruction.yaml
```
### 3. Run the server (stdio mode)
```bash
npx instruction-mcp -c instruction.yaml
```
## Use with Claude Desktop
Add to your Claude Desktop config:
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
```json
{
"mcpServers": {
"my-instructions": {
"command": "npx",
"args": ["instruction-mcp", "-c", "instruction.yaml"],
"cwd": "/absolute/path/to/this/example"
}
}
}
```
## Docker Deployment
### Dockerfile
```dockerfile
FROM node:20-alpine
WORKDIR /app
# Copy your config and resources
COPY instruction.yaml .
COPY resources/ resources/
# Install instruction-mcp globally
RUN npm install -g instruction-mcp
EXPOSE 3000
# Run in stdio mode (for MCP)
CMD ["instruction-mcp", "-c", "instruction.yaml"]
```
### Build and run
```bash
docker build -t my-instructions .
docker run -i my-instructions
```
### docker-compose.yml
```yaml
version: '3.8'
services:
instructions:
build: .
stdin_open: true
volumes:
# Mount for live updates (optional)
- ./resources:/app/resources:ro
```
## Project Structure
```
example/
├── instruction.yaml # Tool definitions
└── resources/
├── workflow/
│ ├── workflow.md # Project workflow overview
│ ├── debugging.md # Debugging guide
│ └── reporting.md # Reporting best practices
└── code-review.md # Code review checklist
```
## Available Tools
| Tool | Description | Instructions |
|------|-------------|--------------|
| `get_project_workflow` | Project workflow guides | overview (default), debugging, reporting |
| `get_code_review_checklist` | Code review standards | default |
