praisonai serve command launches various PraisonAI server types with unified discovery support.
Server Types
| Command | Protocol | Port | Description |
|---|---|---|---|
praisonai serve agents | HTTP | 8000 | Agents as HTTP REST API |
praisonai serve gateway | WebSocket | 8765 | Multi-agent real-time coordination |
praisonai serve mcp | STDIO/SSE | 8080 | MCP server for Claude/Cursor |
praisonai serve acp | STDIO | - | Agent Client Protocol for IDEs |
praisonai serve lsp | STDIO | - | Language Server Protocol |
praisonai serve ui | HTTP | 8082 | Chainlit web interface |
praisonai serve rag | HTTP | 9000 | RAG query server |
praisonai serve registry | HTTP | 7777 | Package registry server |
praisonai serve docs | HTTP | 3000 | Documentation preview |
praisonai serve scheduler | Background | - | Job scheduler daemon |
praisonai serve recipe | HTTP | 8765 | Recipe runner server |
praisonai serve a2a | JSON-RPC | 8001 | Agent-to-Agent protocol |
praisonai serve a2u | SSE | 8002 | Agent-to-User event stream |
praisonai serve unified | HTTP/SSE | 8765 | All providers combined |
Bot Servers (Messaging Platforms)
| Command | Protocol | Description |
|---|---|---|
praisonai bot telegram | Telegram API | Connect agent to Telegram |
praisonai bot discord | Discord API | Connect agent to Discord |
praisonai bot slack | Slack API | Connect agent to Slack |
Quick Start
Usage
Basic Server
Custom Port and Host
Alternative Flag Style
API Endpoints
When the server starts, it automatically creates these endpoints:| Endpoint | Method | Description |
|---|---|---|
/agents | POST | Run ALL agents sequentially |
/agents/{name} | POST | Run a specific agent |
/agents/list | GET | List all available agents |
/health | GET | Health check |
/docs | GET | Swagger API documentation |
Run All Agents
Run Specific Agent
List Available Agents
Example agents.yaml
Integration with n8n
The serve command works seamlessly with n8n workflows:- Visualize agent execution flow
- Add conditional logic between agents
- Integrate with other n8n nodes
Use Cases
Microservices
Expose agents as REST APIs for microservice architectures
n8n Integration
Connect agents to n8n workflows for automation
Web Applications
Backend API for web or mobile applications
Testing
Test agents via HTTP requests during development
Python SDK Equivalent
The serve command is equivalent to:Command Options
Global Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Server host to bind to |
--port | varies | Server port |
Agents Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8000 | Port to bind to |
--file | agents.yaml | Agents YAML file |
--reload | false | Enable hot reload |
--api-key | - | API key for authentication |
Gateway Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8765 | Port to bind to |
--agents | - | Agents YAML file |
MCP Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8080 | Port to bind to |
--transport | stdio | Transport: stdio, sse, http-stream |
--name | - | Server name from config |
ACP Server Options
| Option | Default | Description |
|---|---|---|
--workspace | . | Project workspace path |
--agent | default | Agent name or config file |
--model | - | LLM model to use |
--debug | false | Enable debug logging |
LSP Server Options
| Option | Default | Description |
|---|---|---|
--language | python | Language server type |
UI Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8082 | Port to bind to |
--type | agents | UI type: agents, chat, code, realtime |
RAG Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 9000 | Port to bind to |
--collection | default | Collection name |
Registry Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 7777 | Port to bind to |
--token | - | Authentication token |
--read-only | false | Read-only mode |
Docs Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 3000 | Port to bind to |
--path | . | Documentation path |
Scheduler Options
| Option | Default | Description |
|---|---|---|
--config | - | Scheduler config file |
--daemon | false | Run as daemon |
Recipe Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8765 | Port to bind to |
--config | - | Config file path |
--reload | false | Enable hot reload |
A2A Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8001 | Port to bind to |
--file | agents.yaml | Agents YAML file |
A2U Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8002 | Port to bind to |
Unified Server Options
| Option | Default | Description |
|---|---|---|
--host | 127.0.0.1 | Host to bind to |
--port | 8765 | Port to bind to |
--file | agents.yaml | Agents YAML file |
--reload | false | Enable hot reload |
Bot Server Options (Telegram, Discord, Slack)
| Option | Default | Description |
|---|---|---|
--token | - | Bot API token (or use env var) |
--agent-file | - | Agent configuration file |
TELEGRAM_BOT_TOKEN- Telegram bot tokenDISCORD_BOT_TOKEN- Discord bot tokenSLACK_BOT_TOKEN- Slack bot token
Discovery Endpoint
All servers expose a unified discovery endpoint at/__praisonai__/discovery:
Server-Specific Commands
A2A Server
A2U Server
MCP Server
Tools MCP Server
Related
- Endpoints CLI - Client for all server types
- n8n Integration
- Workflows
- A2A Server
- Tools MCP Server

