Skip to main content
All PraisonAI servers are accessible through praisonai serve <type> - one command to start any server.

​
Quick Start

1

Start Agents Server

praisonai serve agents --port 8000
2

Start Gateway Server

praisonai serve gateway --port 8765
3

Start All-in-One Server

praisonai serve unified --port 8765

​
All Serve Commands

Run praisonai serve to see all available options with descriptions.
CommandProtocolPortDescription
praisonai serve agentsHTTP8000Agents as HTTP REST API
praisonai serve gatewayWebSocket8765Multi-agent real-time coordination
praisonai serve mcpSTDIO/SSE8080MCP server for Claude/Cursor
praisonai serve acpSTDIO-Agent Client Protocol for IDEs
praisonai serve lspSTDIO-Language Server Protocol
praisonai serve uiHTTP8082Chainlit web interface
praisonai serve ragHTTP9000RAG query server
praisonai serve registryHTTP7777Package registry server
praisonai serve docsHTTP3000Documentation preview
praisonai serve schedulerBackground-Job scheduler daemon
praisonai serve recipeHTTP8765Recipe runner server
praisonai serve a2aJSON-RPC8001Agent-to-Agent protocol
praisonai serve a2uSSE8002Agent-to-User event stream
praisonai serve unifiedHTTP/SSE8765All providers combined

​
Server Details

HTTP REST API for agents.
praisonai serve agents --file agents.yaml --port 8000
Options:
OptionDefaultDescription
--host127.0.0.1Host to bind to
--port8000Port to bind to
--fileagents.yamlAgents YAML file
--reloadfalseEnable hot reload
--api-key-API key for auth
Test with curl:
curl http://localhost:8000/

​
How It Works

​
Common Patterns

praisonai serve agents --reload --port 8000
Changes to agents.yaml auto-reload the server.
praisonai serve agents --api-key $API_KEY --host 0.0.0.0
Bind to all interfaces with API key authentication.
# Terminal 1: Agents API
praisonai serve agents --port 8000

# Terminal 2: Gateway
praisonai serve gateway --port 8765

# Terminal 3: MCP
praisonai serve mcp --transport sse --port 8080
Run different server types simultaneously.
praisonai serve unified --port 8765 --reload
Single server with all providers for development.

​
Discovery Endpoint

All HTTP servers expose /__praisonai__/discovery for endpoint discovery. 
curl http://localhost:8000/__praisonai__/discovery

{
  "server_name": "praisonai-agents",
  "version": "1.0.0",
  "providers": [...],
  "endpoints": [...]
}

​
Best Practices

Start with praisonai serve unified during development to access all providers. Split into separate servers for production.
Use --host 0.0.0.0 to accept external connections. Default 127.0.0.1 only accepts local connections.
Always use --api-key when exposing servers publicly. Never run unauthenticated servers on public networks.

Agents Server

HTTP REST API details

Gateway Server

WebSocket coordination

MCP Server

Claude Desktop integration

A2A Server

Agent-to-Agent protocol