Dixa MCP Server

🚀 Dixa MCP Server

This is a FastMCP server that provides tools for interacting with the Dixa API. It allows you to search conversations, retrieve conversation details, manage tags, and more.

🚀 Quick Start

📦 Installation

To run the server, follow these steps:

1. Install dependencies:

npm install
npm install fastmcp

2. Set environment variables:

cp .env.example .env

Then edit the .env file and add your Dixa API key:

DIXA_API_KEY=your_api_key_here

3. Start the server:

# Example of testing the server using CLI:
npx fastmcp dev src/tools/index.ts

# Example of testing the server using MCP Inspector:
npx fastmcp inspect src/tools/index.ts

💻 Usage in Claude

To use this server in Claude:

1. Open the development mode.
2. In Claude, go to Settings > Developers > Edit Configuration.
3. Add the following configuration:

{
  "mcpServers": {
    "dixa-mcp-server": {
      "command": "npx",
      "args": [
        "tsx",
        "/PATH/TO/FOLDER/dixa-mcp-server/src/tools/index.ts"
      ],
      "env": {
        "DIXA_API_KEY": "YOUR_API_KEY_TO_DIXA"
      }
    }
  }
}

💻 Usage with Server-Sent Events (SSE)

You can also run the server with SSE support:

server.start({
  transportType: "sse",
  sse: {
    endpoint: "/sse",
    port: 8080,
  },
});

This will start the server and listen for SSE connections at http://localhost:8080/sse.

You can connect to the server using SSEClientTransport:

import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js";

const client = new Client(
  {
    name: "example-client",
    version: "1.0.0",
  },
  {
    capabilities: {},
  },
);

const transport = new SSEClientTransport(new URL(`http://localhost:8080/sse`));

await client.connect(transport);

✨ Features

Conversation Management

• searchConversations: Search for conversations in Dixa, supporting pagination.
• getConversation: Retrieve a single conversation by ID.
• getConversationMessages: Get all messages of a specific conversation.
• getConversationTags: Get all tags associated with a specific conversation.
• getConversationNotes: Get all internal notes of a specific conversation.
• getConversationRatings: Get all ratings of a specific conversation.

Tag Management

• listTags: List all available tags in Dixa.
• tagConversation: Add a tag to a specific conversation.
• removeConversationTag: Remove a tag from a specific conversation.

End-User Management

• getEndUser: Get detailed information about a specific end-user.
• getEndUserConversations: Get all conversations of a specific end-user.

Agent Management

• getAgent: Get detailed information about a specific agent.
• listAgents: List all agents, with optional filtering.

Analytics

• getAnalyticsMetric: Get detailed information about a specific analytics metric.
• getAnalyticsRecord: Get detailed information about a specific analytics record.
• listAnalyticsRecords: List all available analytics record IDs.
• listAnalyticsMetrics: List all available analytics metric IDs.
• getAnalyticsFilter: Get possible values for a given analytics filter attribute.
• getAnalyticsRecordsData: Get analytics data for a specific record using filters and a time period.
• getAnalyticsMetricsData: Get analytics data for a specific metric using filters, a time period, and aggregation.