Documentation

Complete documentation for the autoplans.dev platform, including API reference, MCP server integration, and feature guides.

🔌

Guides

🔌

API Reference

The autoplans.dev API provides programmatic access to project management, task management, and AI planning functionality with both session-based and API key authentication.

Base URL

https://app.autoplans.dev/api/v1

Authentication

Authorization: Bearer apk_live_xxx

Core Endpoints

POST

/api/v1/keys

Create a new API key with scopes

GET

/api/v1/projects

List all projects with pagination and filters

POST

/api/v1/projects

Create a new project

GET

/api/v1/projects/:id/tasks

List tasks in a project

POST

/api/v1/projects/:id/tasks

Create a new task

POST

/api/v1/projects/:id/plan

Generate AI-powered project plan

API Scopes

projects:read

Read project information

projects:write

Manage projects

tasks:read

Read task information

tasks:write

Manage tasks

ai:execute

Execute AI planning

admin:access

Admin panel access

Rate Limits

Free

100 req/hr

Starter

500 req/hr

Pro

2,000 req/hr

Enterprise

Custom

Code Examples

JavaScript

const response = await fetch('https://app.autoplans.dev/api/v1/projects', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer apk_live_xxx',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ name: 'My Project' })
});

Python

response = requests.post(
    'https://app.autoplans.dev/api/v1/projects',
    headers={'Authorization': 'Bearer apk_live_xxx'},
    json={'name': 'My Project'}
)

🤖

MCP Server

The Model Context Protocol (MCP) Server enables GitHub Copilot, Claude Desktop, and other AI tools to interact with autoplans.dev through a standardized protocol.

🔄

Seamless Integration

Works with GitHub Copilot, Claude Desktop, and MCP-compatible clients

🛠️

Comprehensive Tools

Access all autoplans.dev functionality through MCP tools

⚡

Real-time Data

Read project and task data as MCP resources

🔒

Secure Authentication

API key-based auth with fine-grained scopes

Installation

# Install globally

npm install -g @autoplans/mcp-server

# Run the server

autoplans-mcp-server

Available MCP Tools

create_project

Create a new project

list_projects

List all projects

get_project

Get project details

create_task

Create a new task

list_tasks

List project tasks

generate_plan

AI-powered planning

GitHub Copilot Usage

Once configured, use @autoplans in GitHub Copilot Chat:

@autoplans create a project called 'E-commerce Platform'

@autoplans generate a plan for implementing user auth

@autoplans show me all my projects

@autoplans create a high-priority task 'Implement OAuth'

✨

Platform Features

🤖

AI Planning Agent

Conversational AI transforms project descriptions into structured task breakdowns with LangChain + OpenRouter

LangChainGPT-4Claude

⚡

Auto-Execution

Temporal workflows orchestrate long-running tasks with automatic GitHub integration

TemporalWorkflows

🔄

PR Automation

AI agents create branches, commit code, and open pull requests automatically

GitHubAutomation

💬

Chat Interface

Real-time WebSocket-powered chat for interactive AI planning sessions

WebSocketReal-time

🎨

Brand Generator

AI-powered branding assistant creates logos, color schemes, and design systems

AI DesignBranding

📊

Token Tracking

Monitor AI token usage across tiers with real-time alerts and usage analytics

AnalyticsMonitoring

🔐

GitHub Integration

OAuth authentication, profile sync, and repository management

OAuthGitHub App

💳

Billing (Polar.sh)

Subscription management with Polar.sh integration for payments

PaymentsSaaS

👥

Admin Panel

Comprehensive admin dashboard for user, project, and system management

AdminManagement

📚

User Guides

Getting Started

Setup

Complete setup guide for running autoplans.dev locally with Docker, MySQL, Redis, and Temporal

API Integration Guide

Development

Learn how to integrate autoplans.dev API into your applications with examples

MCP Quick Start

Integration

Set up GitHub Copilot integration with the MCP server in minutes

AI Agent Testing

Testing

Best practices for testing AI agents, planning workflows, and task execution

GitHub Integration

Setup

Configure GitHub OAuth, repository access, and webhook handling

Error Handling

Development

Comprehensive guide to error codes, handling patterns, and debugging

🏗️

Architecture

autoplans.dev is built as a pnpm workspace monorepo with VPS-based deployment:

Tech Stack

•Next.js 16 (App Router) + React 19
•MySQL 8.0 + Prisma ORM
•Redis (sessions, caching, rate limiting)
•Temporal (workflow orchestration)
•LangChain + OpenRouter (AI)
•GitHub App Integration

Monorepo Structure

•packages/web - Next.js frontend + API
•packages/shared - Shared utilities & DB
•packages/temporal - Workflow workers
•packages/mcp-server - MCP integration
•pnpm workspace configuration

Key Architectural Decisions

•VPS-hosted monolith - Single server deployment with all services co-located
•Multi-subdomain architecture - app.*, admin.*, docs.* subdomains with Nginx reverse proxy
•Temporal for orchestration - Durable workflows for long-running AI tasks
•OpenRouter for AI - Multi-model LLM access (GPT-4, Claude, etc.)
•Redis for real-time - WebSocket pub/sub, session management, rate limiting

Need Help?

Get support, report issues, or contribute to the project

GitHub Repository Report Issues Email Support