Sergehuber Inoyu MCP Unomi Server

🚀 Inoyu MCP-Unomi Server

The Inoyu MCP-Unomi Server is a powerful tool designed to integrate with the Unomi server, providing seamless data management and user profiling capabilities. It simplifies the process of interacting with Unomi, allowing developers to focus on building great applications.

🚀 Quick Start

📦 Installation

Run the following command to install the project dependencies:

npm install @inoyu/mcp-unomi-server --save-dev

⚙️ Configuration

Create or Edit the Configuration File

Create or edit the configuration file at the following locations:

• MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%/Claude/claude_desktop_config.json

Add the following server configuration to run the latest version of the server using the NPX command:

{
  "mcpServers": {
    "unomi-server": {
      "command": "npx",
      "args": ["@inoyu/mcp-unomi-server"],
      "env": {
        "UNOMI_BASE_URL": "http://your-unomi-server:8181",
        "UNOMI_USERNAME": "your-username",
        "UNOMI_PASSWORD": "your-password",
        "UNOMI_PROFILE_ID": "your-profile-id",
        "UNOMI_KEY": "your-unomi-key",
        "UNOMI_EMAIL": "your-email@example.com",
        "UNOMI_SOURCE_ID": "claude-desktop"
      }
    }
  }
}

If you need to use a specific version, you can configure it as follows:

{
  "mcpServers": {
    "unomi-server": {
      "command": "npx",
      "args": ["@inoyu/mcp-unomi-server@0.1.0"],
      "env": {
        // ... Environment variable configuration ...
      }
    }
  }
}

For the local development environment, you can specify the local build file:

{
  "mcpServers": {
    "unomi-server": {
      "command": "node",
      "args": ["/path/to/local/mcp-unomi-server/build/index.js"],
      "env": {
        // ... Environment variable configuration ...
      }
    }
  }
}

💻 Usage

Basic Commands

1. Install Dependencies:

   npm install @inoyu/mcp-unomi-server --save-dev
   

2. Run the Server (Development Environment):

   npm run dev unomi-server
   

3. Build the Production Package:

   npm run build unomi-server
   

4. Debug the Server:

   npm run debug unomi-server
   

Environment Variable Configuration

The following are the environment variables required for the server to run:

Features

1. Automatic API Key Retrieval

When the UNOMI_KEY environment variable is not manually specified, the server will automatically obtain the API access key from Unomi.

2. Logging

Supports configuring the logging function through the UNOMI_EMAIL environment variable, facilitating debugging and issue troubleshooting.

🔧 Debugging Guide

Start Debug Mode

In the development environment, you can start the debug mode by running the following command:

npm run debug unomi-server

Check the Running Status

Run the following command to check the server status:

npm run status unomi-server

🛠️ Troubleshooting

Common Issues

1. Unable to Connect to the Unomi Service

   • Ensure that the UNOMI_BASE_URL is configured correctly.
   • Check the network connection to ensure that the address can be accessed.

2. Authentication Failure

   • Confirm that the UNOMI_USERNAME and UNOMI_PASSWORD are correct.
   • If using a non-interactive method, check if the Unomi service allows anonymous access.

Log Analysis

The server outputs detailed log information during operation, which is convenient for troubleshooting. By default, the logs are output to the console and can be redirected to a file using the following command:

npm run debug unomi-server > debug.log 2>&1

⚙️ Advanced Features

Automatic Configuration

By setting the UNOMI_PROFILE_ID environment variable, the server can automatically load the data configuration of the specified user.

API Call Example

The following is an example of calling the get_my_profile function:

const profile = await getMyProfile();
console.log(profile);

⚠️ Important Notes

Security Tips

• Do not store sensitive information such as passwords and keys in plain text in the production environment.
• It is recommended to update the API key regularly and limit its scope of use.

Performance Optimization

• Configure an appropriate connection pool size to avoid database bottlenecks.
• Enable the caching mechanism to improve data access efficiency.

📚 Appendix

Environment Variable Reference Table

Command Line Tools

The server provides the following command line tools:

1. Status Check:

   npm run status unomi-server
   

2. Log Output:

   npm run logs unomi-server
   

3. Service Restart:

   npm run restart unomi-server
   

📞 Contact

If you have any questions or suggestions, please contact: your.email@example.com

Thank you for using the Inoyu MCP-Unomi Server! For more help, please refer to our official documentation and updates.