DevOps AI Toolkit

DevOps AI Toolkit Logo

DevOps AI Toolkit is an AI-powered development productivity platform that enhances software development workflows through intelligent automation and AI-driven assistance.

Who is this for?

Kubernetes Deployment

Developers: Deploy applications without needing deep Kubernetes expertise
Platform Engineers: Create organizational deployment patterns that enhance AI recommendations with institutional knowledge and best practices, and scan cluster resources to enable semantic matching for dramatically improved recommendation accuracy

Documentation Testing

Documentation Maintainers: Automatically validate documentation accuracy and catch outdated content
Technical Writers: Identify which sections need updates and prioritize work effectively
Open Source Maintainers: Ensure documentation works correctly for new contributors

Shared Prompts Library

Development Teams: Share proven prompts across projects without file management
Project Managers: Standardize workflows with consistent prompt usage across teams
Individual Developers: Access curated prompt library via native slash commands

AI Integration

AI Agents: Integrate all capabilities with Claude Code, Cursor, or VS Code for conversational workflows

Key Features

Kubernetes Deployment Intelligence

🔍 Smart Discovery: Automatically finds all available resources and operators in your cluster 🧠 Semantic Capability Management: Discovers what each resource actually does for intelligent matching 🤖 AI Recommendations: Get deployment suggestions tailored to your specific cluster setup with enhanced semantic understanding 🔧 Operator-Aware: Leverages custom operators and CRDs when available 🚀 Complete Workflow: From discovery to deployment with automated Kubernetes integration

Capability-Enhanced Recommendations

Transform how AI understands your cluster by discovering semantic capabilities of each resource:

The Problem: Traditional discovery sees sqls.devopstoolkit.live as a meaningless name among hundreds of resources.

The Solution: Capability management teaches the system that sqls.devopstoolkit.live handles PostgreSQL databases with multi-cloud support.

Before Capability Management:

User: "I need a PostgreSQL database"
AI: Gets 400+ generic resource names → picks complex multi-resource solution
Result: Misses optimal single-resource solutions

After Capability Management:

User: "I need a PostgreSQL database"  
AI: Gets pre-filtered relevant resources with rich context
Result: Finds sqls.devopstoolkit.live as perfect match ✨

Get Started: See the Tools and Features Overview for complete guide to all available tools including capability management, deployment recommendations, and workflow integration.

Documentation Testing & Validation

📖 Automated Testing: Validates documentation by executing commands and testing examples 🔍 Two-Phase Validation: Tests both functionality (does it work?) and semantic accuracy (are descriptions truthful?) 🛠️ Fix Application: User-driven selection and application of recommended documentation improvements 💾 Session Management: Resumable testing workflows for large documentation sets

Organizational Pattern Management

🏛️ Pattern Creation: Define organizational deployment patterns that capture institutional knowledge 🧠 AI Enhancement: Patterns automatically enhance deployment recommendations with organizational context 🔍 Semantic Search: Uses Vector DB technology for intelligent pattern matching based on user intent 📋 Best Practices: Share deployment standards across teams through reusable patterns

Shared Prompts Library

🎯 Native Slash Commands: Prompts appear as /dot-ai:prompt-name in your coding agent 📚 Curated Library: Access proven prompts for code review, documentation, architecture, and project management 🔄 Zero Setup: Connect to MCP server and prompts are immediately available across all projects 🤝 Team Consistency: Standardized prompt usage with centralized management

AI Integration

⚡ MCP Integration: Works seamlessly with Claude Code, Cursor, or VS Code through Model Context Protocol 🤖 Conversational Interface: Natural language interaction for deployment, documentation testing, pattern management, and shared prompt workflows

Setup Required: See the MCP Setup Guide for complete configuration instructions.

See It In Action

This video explains the platform engineering problem and demonstrates the Kubernetes deployment recommendation workflow from intent to running applications.

Quick Start

Prerequisites

For Kubernetes deployment and documentation testing:

Claude API key (required for AI analysis)
- Get your API key from Anthropic Console (requires account login)
- Set it as environment variable: export ANTHROPIC_API_KEY=your_api_key_here

For shared prompts library:

No API key required - Works with any MCP-enabled coding agent (other features like deployments do require ANTHROPIC_API_KEY)

For Kubernetes deployment recommendations:

kubectl configured with cluster access
- Verify cluster access with: kubectl get nodes
- Should show your cluster nodes without authentication errors

For documentation testing:

Documentation files to test (Markdown, HTML, etc.)
File system access to the documentation you want to validate

For organizational pattern management:

Vector DB service (Qdrant) for pattern storage and semantic search
OpenAI API key (required) for semantic pattern matching and vector operations
See the Pattern Management Guide for complete setup

Installation

DevOps AI Toolkit is designed to be used through AI development tools via MCP (Model Context Protocol). No direct installation needed - simply configure your AI tool to connect to the MCP server.

Usage

🎯 Recommended: Docker Setup (Complete Stack)Perfect for getting all features working immediately with minimal setup:

Download Docker Compose configuration:

curl -o docker-compose-dot-ai.yaml https://raw.githubusercontent.com/vfarcic/dot-ai/main/docker-compose-dot-ai.yaml

Set environment variables and create MCP configuration:

# Set your API keys
export ANTHROPIC_API_KEY="sk-ant-api03-your-key-here"
export OPENAI_API_KEY="sk-proj-your-openai-key-here"

# Create MCP configuration for Claude Code
cat > .mcp.json << 'EOF'
{
  "mcpServers": {
    "dot-ai": {
      "command": "docker",
      "args": [
        "compose", 
        "-f",
        "docker-compose-dot-ai.yaml",
        "--env-file",
        ".env",
        "run", 
        "--rm",
        "--remove-orphans",
        "dot-ai"
      ]
    }
  }
}
EOF

What you get:

✅ Complete Stack: MCP server + Qdrant vector database included
✅ All Features Working: Capability management, pattern storage, semantic search
✅ No External Dependencies: Everything runs in containers
✅ Kubernetes Integration: Direct kubectl access to your clusters

Alternative Methods: See the MCP Setup Guide for NPX (Node.js) and Development setup options.

Start your MCP client:

claude  # or your preferred MCP-enabled AI tool

# Verify everything works by asking:
"Show dot-ai status"

Use conversational workflows:

Example: Kubernetes Deployment

User: I want to deploy a web application to my cluster

Agent: I'll help you deploy a web application. Let me get recommendations based on your cluster.
[Uses recommend tool]

Agent: I found 3 options. Let's use Kubernetes Deployment + Service. 
What's your application name and container image?

User: App name is "myapp" and image is "nginx:latest"

Agent: Perfect! Generating manifests and deploying now...
[Uses chooseSolution, answerQuestion, generateManifests, deployManifests]

Agent: ✅ Successfully deployed! Your application is running.

Example: Capability Management

User: I want to scan my cluster for resource capabilities to improve recommendations

Agent: I'll help you scan your cluster to discover semantic capabilities. This will dramatically improve recommendation accuracy.
[Uses manageOrgData with capabilities scanning]

Agent: Would you like to scan all cluster resources or specify a subset?
Options: 1) All resources 2) Specific subset

User: All resources in auto mode

Agent: Starting comprehensive cluster capability scan...
✅ Capability scan completed! Processed cluster resources successfully.

User: Now I need a PostgreSQL database

Agent: Let me get enhanced recommendations using your capability data.
[Uses recommend tool with capability pre-filtering]

Agent: Perfect! I found sqls.devopstoolkit.live as the top match - it's a managed database solution supporting PostgreSQL with multi-cloud capabilities and low complexity. Much better than the generic StatefulSet approach I would have suggested before!

Example: Documentation Testing

User: I want to test my README.md file to make sure all the examples work

Agent: I'll help you test your README.md for accuracy. Let me start a documentation testing session.
[Uses testDocs tool]

Agent: Found 6 testable sections in your README. Testing installation instructions...

✅ npm install command works correctly
❌ Configuration example has wrong port number (8080 vs 3000)
⚠️  Claims "works out of the box" but requires additional setup

Which issues would you like me to help you fix?

User: Fix the port number directly in the doc, and I'll create a GitHub issue for the setup requirements.

Agent: ✅ Documentation testing complete! Fixed 1 issue directly, 1 issue tracked externally.

Note: Conversational examples are illustrative - actual AI responses will vary based on specific context and implementation.

Example: Shared Prompts Library

# Conversational approach
User: I want to create a new PRD for a feature

Agent: I'll help you create a documentation-first PRD. Let me start the process.
[Uses prd-create prompt via /dot-ai:prd-create]

Agent: Great! I've created GitHub issue #34 and the PRD file. What feature would you like to document?

# Direct slash command approach  
User: /dot-ai:prd-create

Agent: I'm executing the PRD creation workflow. Please describe the feature you want to create a PRD for...

📖 Complete MCP Setup Guide → - Detailed configuration, troubleshooting, and examples

Troubleshooting

MCP Issues

MCP server won't start:

Verify environment variables are correctly configured in .mcp.json env section
Check session directory exists and is writable
Ensure ANTHROPIC_API_KEY is valid

"No active cluster" errors:

Verify kubectl connectivity: kubectl cluster-info
Check KUBECONFIG path in environment variables
Test cluster access: kubectl get nodes

Documentation

🚀 Getting Started

MCP Setup Guide - Complete configuration instructions for AI tools integration
Tools and Features Overview - Comprehensive guide to all available tools and features

Support

Issues: GitHub Issues

Contributing

We welcome contributions! Please:

Fork the repository and create a feature branch
Run tests with npm test to ensure changes work correctly
Follow existing code style and conventions
Submit a pull request with a clear description of changes

License

MIT License - see LICENSE file for details.

DevOps AI Toolkit - AI-powered development productivity platform for enhanced software development workflows.

DevOps AI Toolkit