steering-generator-mcp 0.1.1

MCP Server to auto-generate steering/context docs from codebases - like Kiro IDE's built-in feature, but for all AI IDEs

Steering Generator MCP Server

MCP Server to auto-generate steering/context docs from codebases — like Kiro IDE's built-in feature, but for all AI IDEs (Cursor, VS Code, Windsurf, Cline, Aider, etc).

---

🚀 One-Click Install

Kiro IDE

Add to .kiro/settings/mcp.json:

{
  "mcpServers": {
    "steering-generator": {
      "command": "uvx",
      "args": ["steering-generator-mcp"]
    }
  }
}

Cursor

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "steering-generator": {
      "command": "uvx",
      "args": ["steering-generator-mcp"]
    }
  }
}

VS Code + Copilot

Add to .vscode/mcp.json:

{
  "mcpServers": {
    "steering-generator": {
      "command": "uvx",
      "args": ["steering-generator-mcp"]
    }
  }
}

Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "steering-generator": {
      "command": "uvx",
      "args": ["steering-generator-mcp"]
    }
  }
}

Claude Desktop

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "steering-generator": {
      "command": "uvx",
      "args": ["steering-generator-mcp"]
    }
  }
}

Cline (VS Code Extension)

Add to Cline MCP settings:

{
  "mcpServers": {
    "steering-generator": {
      "command": "uvx",
      "args": ["steering-generator-mcp"]
    }
  }
}

---

📦 Alternative: pip install

If you don't have uvx, install with pip first:

pip install steering-generator-mcp

Then use this config instead:

{
  "mcpServers": {
    "steering-generator": {
      "command": "steering-generator"
    }
  }
}

---

💬 Usage

Just chat with your AI:

"Generate steering docs for this project"

Done! AI will generate context files automatically.

---

What Does It Generate?

3 Foundational Steering Files (like Kiro)

File	Purpose
product.md	Product overview, target users, key features, business objectives
tech.md	Technology stack, frameworks, libraries, dev tools, constraints
structure.md	File organization, naming conventions, import patterns, architecture

Output Formats per IDE

IDE	Output Location
Kiro	.kiro/steering/*.md (multiple files)
Cursor	.cursor/rules/project.mdc
GitHub Copilot	.github/copilot-instructions.md
Windsurf	.windsurfrules
Cline	.clinerules
Aider	CONVENTIONS.md

---

Supported Frameworks

• ✅ Next.js (App Router & Pages)
• ✅ React (Vite/CRA)
• ✅ Vue.js (Vite)
• ✅ Nuxt.js
• ✅ Laravel 12

---

Features

Inclusion Modes

Control when steering files are loaded:

---
inclusion: always          # Always loaded (default)
---

---
inclusion: fileMatch
fileMatchPattern: "app/api/**/*"   # Only when working on matching files
---

---
inclusion: manual          # On-demand via #steering-file-name
---

File References

Reference other files in your steering docs:

#[[file:lib/types.ts]]
#[[file:api/openapi.yaml]]

Custom Steering Templates

Built-in templates for common patterns:

• api - REST API standards
• testing - Testing conventions
• security - Security policies
• code-style - Code conventions
• deployment - Deployment workflow
• components - Component patterns

---

MCP Tools

Tool	Description
generate_steering	Generate foundational steering docs
deep_analyze_project	Deep analysis with categorized deps, patterns, entities
create_custom_steering	Create custom steering with inclusion mode
get_steering_template	Get template for common patterns
detect_project_framework	Detect framework (nextjs/react/vue/laravel)
list_supported_frameworks	List supported frameworks
list_supported_ides	List supported IDE output formats

---

Example Output

.kiro/steering/tech.md

---
inclusion: always
---

# Technology Stack

## Framework & Runtime

- **Framework**: Next.js 15 (App Router)
- **UI Library**: React 19
- **Language**: TypeScript 5

## Database & Backend

- **Database**: Supabase (PostgreSQL)
- **Auth**: Supabase Auth

## UI & Styling

- **CSS Framework**: Tailwind CSS
- **Component Library**: shadcn/ui
- **Icons**: Lucide React

## Key Libraries

- **Validation**: Zod
- **Forms**: React Hook Form
- **State**: Zustand

## Development Commands

```bash
npm run dev       # Start dev server
npm run build     # Build for production

---

## Requirements

- Python 3.10+
- [uv](https://docs.astral.sh/uv/getting-started/installation/) (for `uvx` command) OR pip

### Optional: Ripgrep

For faster scanning on large codebases:

```bash
# Windows
winget install BurntSushi.ripgrep

# Mac
brew install ripgrep

# Linux
sudo apt install ripgrep

---

License

MIT

---

Links

• PyPI Package
• GitHub Repository
• Report Issues