Skip to main content
Deploy all PraisonAI capabilities as an MCP server for Claude Desktop, Cursor, Windsurf, and other MCP clients.

Quick Start

1

Install Dependencies

pip install "praisonai[mcp]"
2

Set API Key

export OPENAI_API_KEY="your-key"
3

Start MCP Server

praisonai mcp serve --transport stdio

CLI - STDIO Transport

For Claude Desktop, Cursor, Windsurf local integration:
praisonai mcp serve --transport stdio

CLI - HTTP Stream Transport

For remote access (MCP 2025-11-25 spec):
praisonai mcp serve --transport http-stream --port 8080
Expected Output:
✓ Starting MCP server 'praisonai' on http://127.0.0.1:8080/mcp

CLI Options

OptionDefaultDescription
--transportstdiostdio or http-stream
--host127.0.0.1HTTP host
--port8080HTTP port
--endpoint/mcpHTTP endpoint path
--api-key-API key for auth
--namepraisonaiServer name
--response-modebatchbatch or stream
--cors-origins-Comma-separated CORS origins
--allowed-origins-Allowed origins for security
--session-ttl3600Session TTL in seconds
--log-levelwarningdebug, info, warning, error

Python SDK

from praisonai.mcp_server import MCPServer

server = MCPServer(
    name="praisonai",
    version="1.0.0",
    instructions="PraisonAI MCP Server - AI agent capabilities"
)

# STDIO transport
server.run(transport="stdio")

# Or HTTP Stream transport
server.run(transport="http-stream", host="127.0.0.1", port=8080)

MCP Protocol Features

FeatureSupportedDescription
ToolsList, call, search tools
ResourcesList, read resources
PromptsList, get prompts
PaginationCursor-based pagination
Tool SearchServer-side tool filtering
ProgressProgress notifications
CancellationRequest cancellation
LoggingSet log level
Protocol Version: 2025-11-25

Generate Client Config

# Claude Desktop
praisonai mcp config-generate --client claude-desktop

# Cursor
praisonai mcp config-generate --client cursor

# VSCode
praisonai mcp config-generate --client vscode

# Windsurf
praisonai mcp config-generate --client windsurf
Claude Desktop Output:
{
  "mcpServers": {
    "praisonai": {
      "command": "praisonai",
      "args": ["mcp", "serve", "--transport", "stdio"]
    }
  }
}

Connect MCP Client

Claude Desktop (claude_desktop_config.json): For STDIO:
{
  "mcpServers": {
    "praisonai": {
      "command": "praisonai",
      "args": ["mcp", "serve", "--transport", "stdio"]
    }
  }
}
For HTTP Stream:
{
  "mcpServers": {
    "praisonai": {
      "url": "http://localhost:8080/mcp",
      "transport": "http-stream"
    }
  }
}
Cursor (.cursor/mcp.json):
{
  "mcpServers": {
    "praisonai": {
      "command": "praisonai",
      "args": ["mcp", "serve", "--transport", "stdio"]
    }
  }
}

List Available Tools

praisonai mcp list-tools
Output:
Available MCP Tools (15 of 42):

  • praisonai.memory.show [read-only]
    Show current memory contents

  • praisonai.workflow.run
    Run a workflow from agents.yaml

  • praisonai.agent.chat
    Chat with an agent
...

Search Tools

# Search by query
praisonai mcp tools search "web"

# Filter by category
praisonai mcp tools search --category memory --read-only

# Get tool info
praisonai mcp tools info praisonai.memory.show

# Get tool schema
praisonai mcp tools schema praisonai.workflow.run

Health Check

praisonai mcp doctor
Output:
PraisonAI MCP Server Health Check

Protocol Version: 2025-11-25
Supported Versions: 2025-11-25, 2025-03-26, 2024-11-05

Registered Components:
  • Tools: 42
  • Resources: 5
  • Prompts: 3

Environment:
  ✓ OPENAI_API_KEY
  ○ ANTHROPIC_API_KEY
  ○ GOOGLE_API_KEY

Dependencies:
  ✓ starlette
  ✓ uvicorn
  ✓ praisonaiagents

✓ MCP server is ready to run

Authentication

For HTTP Stream transport with API key:
praisonai mcp serve --transport http-stream --api-key mykey --port 8080
Client config with auth:
{
  "mcpServers": {
    "praisonai": {
      "url": "http://localhost:8080/mcp",
      "headers": {
        "Authorization": "Bearer mykey"
      }
    }
  }
}

Troubleshooting

IssueFix
Missing depspip install "praisonai[mcp]"
Port in useChange --port
No toolsRun praisonai mcp list-tools
Auth failedCheck --api-key
STDIO not workingCheck command path