Skip to main content
Glama
Kaiohz
by Kaiohz
README.md
# MCP Perplexica

MCP server proxy for [Perplexica](https://github.com/ItzCrazyKns/Perplexica) search API.

This server allows LLMs to perform web searches through Perplexica using the Model Context Protocol (MCP).

## Features

- šŸ” Web search through Perplexica
- šŸ“š Multiple focus modes (web, academic, YouTube, Reddit, etc.)
- ⚔ Configurable optimization modes (speed, balanced, quality)
- šŸ”§ Customizable model configuration
- šŸ“– Source citations in responses
- šŸš€ Multiple transport modes (stdio, SSE, Streamable HTTP)

## Prerequisites

- Python 3.11+
- [UV](https://docs.astral.sh/uv/) package manager
- Running [Perplexica](https://github.com/ItzCrazyKns/Perplexica) instance

## Installation

1. Clone the repository:
```bash
git clone https://github.com/Kaiohz/mcp-perplexica.git
cd mcp-perplexica
```

2. Install dependencies with UV:
```bash
uv sync
```

3. Create your environment file:
```bash
cp .env.example .env
```

4. Edit `.env` with your configuration:
```bash
# Perplexica API
PERPLEXICA_URL=http://localhost:3000

# Transport: stdio (default), sse, or streamable-http
TRANSPORT=stdio
HOST=127.0.0.1
PORT=8000

# Model configuration
DEFAULT_CHAT_MODEL_PROVIDER_ID=your-provider-id
DEFAULT_CHAT_MODEL_KEY=anthropic/claude-sonnet-4.5
DEFAULT_EMBEDDING_MODEL_PROVIDER_ID=your-provider-id
DEFAULT_EMBEDDING_MODEL_KEY=openai/text-embedding-3-small
```

## Usage

### Transport Modes

The server supports three transport modes:

| Transport | Description | Use Case |
|-----------|-------------|----------|
| `stdio` | Standard input/output | CLI tools, Claude Desktop |
| `sse` | Server-Sent Events over HTTP | Web clients |
| `streamable-http` | Streamable HTTP (recommended for production) | Production deployments |

### Running with Docker Compose

The easiest way to run both Perplexica and MCP Perplexica together:

```bash
# Copy and configure environment files
cp .env.example .env
cp .env.perplexica.example .env.perplexica

# Edit .env with your MCP Perplexica settings
# Edit .env.perplexica with your Perplexica settings

# Start services
docker compose up -d
```

This starts:
- **Perplexica** on `http://localhost:3000`
- **MCP Perplexica** connected to Perplexica

### Running the MCP Server (without Docker)

#### Stdio mode (default)
```bash
uv run python src/main.py
```

#### SSE mode
```bash
TRANSPORT=sse PORT=8000 uv run python src/main.py
```

#### Streamable HTTP mode
```bash
TRANSPORT=streamable-http PORT=8000 uv run python src/main.py
```

### Claude Desktop Configuration

Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):

```json
{
  "mcpServers": {
    "perplexica": {
      "command": "uv",
      "args": ["run", "--directory", "/path/to/mcp-perplexica", "python", "-m", "main"],
      "env": {
        "PERPLEXICA_URL": "http://localhost:3000",
        "TRANSPORT": "stdio",
        "DEFAULT_CHAT_MODEL_PROVIDER_ID": "your-provider-id",
        "DEFAULT_CHAT_MODEL_KEY": "anthropic/claude-sonnet-4.5",
        "DEFAULT_EMBEDDING_MODEL_PROVIDER_ID": "your-provider-id",
        "DEFAULT_EMBEDDING_MODEL_KEY": "openai/text-embedding-3-small"
      }
    }
  }
}
```

### Claude Code Configuration

For HTTP-based transports, you can add the server to Claude Code:

```bash
# Start the server with streamable-http transport
TRANSPORT=streamable-http PORT=8000 uv run python -m main

# Add to Claude Code
claude mcp add --transport http perplexica http://localhost:8000/mcp
```

## Available Tools

### `search`

Perform a web search using Perplexica.

**Parameters:**

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The search query |
| `focus_mode` | string | No | Search focus: `webSearch`, `academicSearch`, `writingAssistant`, `wolframAlphaSearch`, `youtubeSearch`, `redditSearch` |
| `optimization_mode` | string | No | Optimization: `speed`, `balanced`, `quality` |
| `system_instructions` | string | No | Custom instructions for AI response |
| `chat_model_provider_id` | string | No | Override default chat model provider |
| `chat_model_key` | string | No | Override default chat model |
| `embedding_model_provider_id` | string | No | Override default embedding provider |
| `embedding_model_key` | string | No | Override default embedding model |

**Example:**
```
Search for "latest developments in AI" using academic focus
```

## Development

### Install dev dependencies

```bash
uv sync --dev
```

### Run tests

```bash
uv run pytest
```

### Run linter

```bash
uv run ruff check .
uv run ruff format .
uv run black src/
```

## Architecture

This project follows hexagonal architecture:

```
src/
ā”œā”€ā”€ main.py              # MCP server entry point
ā”œā”€ā”€ config.py            # Pydantic Settings
ā”œā”€ā”€ dependencies.py      # Dependency injection
ā”œā”€ā”€ domain/              # Business core (pure Python)
│   ā”œā”€ā”€ entities.py      # Dataclasses
│   └── ports.py         # ABC interfaces
ā”œā”€ā”€ application/         # Use cases
│   ā”œā”€ā”€ requests.py      # Pydantic DTOs
│   └── use_cases.py     # Business logic
└── infrastructure/      # External adapters
    └── perplexica/
        └── adapter.py   # HTTP client
```

## License

MIT

TDQS

B3.1/5.0

Scored across 1 tool

Disambiguation5/5

With only one tool, there is no possibility of ambiguity or overlap between tools. The tool 'search' has a single, clearly defined purpose.

Naming Consistency5/5

A single tool inherently has perfect naming consistency, as there are no other tools to compare it against for patterns or conventions.

Tool Count2/5

One tool is too few for a server named 'MCP Perplexica' that implies web search functionality, as it lacks basic operations like refining searches, managing history, or handling different search modes. This feels thin and incomplete for the domain.

Completeness2/5

The tool set is severely incomplete for a web search server. It only provides a single search function with no support for advanced features like filtering, pagination, or handling different types of queries, which are essential for effective search workflows.

Maintenance

ActivityInactive
ResponsivenessNo issues