Dixa

🚀 Dixa MCP Server

A quickly implemented Dixa API MCP server that provides resources and tools for managing conversations and tags.

🚀 Quick Start

This Dixa MCP server offers a set of resources and tools to manage conversations and tags. Here's how to get it up and running:

Configuration

The server requires the following environment variables:

• DIXA_API_KEY: Your Dixa API key
• DIXA_API_BASE_URL (optional): Override the default API URL (default is 'https://dev.dixa.io/v1')

Usage

1. Set the environment variables:

export DIXA_API_KEY='your-api-key'

2. Start the server:

npm start

Testing Your Server

Using mcp-cli

The quickest way to test and debug your server is by using fastmcp dev:

npx fastmcp dev server.js
npx fastmcp dev server.ts

This will run your MCP server in the terminal for testing and debugging using mcp-cli.

Using MCP Inspector

Another way is to use the official MCP Inspector via the Web UI to check your server:

npx fastmcp inspect server.ts

✨ Features

Resources

• Search conversations
• Get conversation details
• Get conversation notes
• Get conversation messages
• Get available tags

Tools

• Add tags to a conversation
• Remove tags from a conversation

📦 Installation

Prerequisites

• Node.js and npm installed on your machine.

Steps

1. Clone the repository to your local machine.
2. Navigate to the project directory.
3. Install the dependencies:

npm install

💻 Usage Examples

Adding a New Resource

1. Create a schema in src/schemas/.
2. Create a resource in src/resources/.
3. Add the resource to src/dixa.ts.

Example resource:

export const myResource = {
  uri: "dixa://my-resource",
  name: "My Resource",
  description: "Description",
  load: async (args: MyResourceArgs, props: MyResourceProps) => {
    // Implementation logic
  }
}

Adding a New Tool

1. Create a tool in src/tools/.
2. Add the tool to src/dixa.ts.

Example tool:

export const myTool = {
  name: "My Tool",
  description: "This is a tool for performing specific tasks.",
  args: {
    type: "object" as const,
    properties: {
      // Define parameters
    }
  },
  fn: async (args: MyToolArgs, props: MyToolProps) => {
    // Implementation logic
  }
}

📚 Documentation

Project Structure

/src
├── dixa.ts             # Main server setup
├── config.ts           # Configuration and environment settings
├── types.ts            # Shared types and error handling
├── resources/          # Resource implementations
├── schemas/           # Zod schemas for validation
└── tools/             # Tool implementations

Frequently Asked Questions

How to use it with Claude Desktop?

Refer to the guide Link and add the following to your configuration:

{
  "mcpServers": {
    "my-mcp-server": {
      "command": "npx",
      "args": [
        "tsx",
        "/PATH/TO/YOUR_PROJECT/src/index.ts"
      ],
      "env": {
        "YOUR_ENV_VAR": "value"
      }
    }
  }
}

Showcases

• Project A: A project demonstrating how to use the Dixa MCP server.
• Project B: Another project showcasing the integration of the Dixa API.

Acknowledgments

We appreciate the contributions of the following projects:

• The FastMCP project (Link) provided the foundation for our implementation.
• The Zod library (Link) is used for data validation and type safety.

Contribution Guidelines

We welcome contributions from the community! Please follow these steps to get involved:

1. Report Issues: Submit any issues or feature requests in the GitHub repository.
2. Implement Features: Check the Issues label to find features that need implementation and start development.
3. Code Review: Actively participate in the review of Pull Requests to ensure code quality and consistency.
4. Contribute to Documentation: Help improve the documentation to make it clearer and more understandable.

Please read our Contribution Guidelines before submitting a Pull Request for more information.