Quick Start Guide 🚀

Get your AI development team up and running in under 5 minutes!

Prerequisites

You'll need:

Python 3.8 or higher
uv - The fast Python package manager

Don't have uv? Install it with:

curl -LsSf https://astral.sh/uv/install.sh | sh

Step 1: Clone and Setup (30 seconds)

# Clone the repository
git clone https://git.tomfos.tr/agile-project-mcp.git
cd agile-project-mcp

# Install all dependencies
uv sync

Step 2: Configure Your AI Provider (1 minute)

Create a .env file with your OpenAI-compatible API endpoint:

# Example for OpenAI
OPENAI_API_KEY=your-api-key-here
OPENAI_API_BASE=https://api.openai.com/v1

# Or for a local Neuromancer instance
OPENAI_API_BASE=http://localhost:8000/v1

Step 3: Start the Server (10 seconds)

uv run agile-project-mcp

🎉 That's it! Your server is now running at http://localhost:8000

Step 4: Create Your First Project

Open a new terminal and try this:

# Using curl
curl -X POST http://localhost:8000/tools/create_project \
  -H "Content-Type: application/json" \
  -d '{"name": "My First AI Project", "description": "Build a simple todo app"}'

Or visit http://localhost:8000/docs for the interactive API documentation!

What's Next?

Chat with your team: Send natural language requests to the /v1/chat/completions endpoint
Use the tools: Check out the Tooling Guide for all available commands
Watch the magic: Your AI team will start breaking down tasks and getting to work!

Development Commands

When you're ready to contribute:

# Run tests
uv run pytest

# Check code quality
uv run ruff check .

# Auto-format code
uv run ruff format .

# Run with debug logging
DEBUG=true uv run agile-project-mcp

Troubleshooting

Server won't start?

Check your Python version: python --version (needs 3.8+)
Make sure port 8000 is free: lsof -i :8000

Can't connect to AI provider?

Verify your API credentials in .env
Test the connection: curl $OPENAI_API_BASE/models

Need help?

Check the Architecture docs for technical details
Review Core Concepts to understand how it works

2.3 KiB Raw Permalink Blame History