Inoyu MCP Unomi Server

🚀 Inoyu MCP Unomi Server Chinese Configuration Guide

Inoyu MCP Unomi Server is an MCP protocol adapter for interacting with Unomi, an Apache CXS project. This document details how to install, configure, and use the server.

🚀 Quick Start

This guide will help you quickly install, configure, and run the Inoyu MCP Unomi Server.

✨ Features

• MCP Protocol Adaptation: Seamlessly interacts with Unomi through the MCP protocol.
• Environment Variable Configuration: Allows flexible configuration via environment variables.
• Session ID Customization: Generates session IDs in a specific format.

📦 Installation

Install the latest version via npm:

npm install -g @inoyu/mcp-unomi-server

To specify a particular version, run the following command:

npm install -g @inoyu/mcp-unomi-server@0.1.0

💻 Usage Examples

Basic Usage

Run the server with default settings:

npx @inoyu/mcp-unomi-server

Advanced Usage

Run the server with specified environment variables:

UNOMI_BASE_URL=http://localhost:8181 \
UNOMI_USERNAME=admin \
UNOMI_PASSWORD=secret \
npx @inoyu/mcp-unomi-server

📚 Documentation

Configuring the MCP Server

Environment Variables

The following are the required environment variables and their descriptions:

Configuration Options

Session ID Format

By default, the session ID generated by the get_my_profile method follows the format:

[profileId]-YYYYMMDD

For example, if the profileId is user123 and the current date is March 15, 2024, the session ID will be user123-20240315.

Debugging

Since the MCP server communicates via standard input and output, debugging can be challenging. We recommend using MCP Inspector to assist with debugging:

npm run inspector

Additionally, you can view the logs of Claude Desktop:

# MacOS
tail -n 20 -f ~/Library/Logs/Claude/mcp*.log

# Windows
tail -n 20 -f %APPDATA%\Claude\mcp*.log

Troubleshooting

Common Issues

1. Protected Event Failure

   • Ensure that the Unomi key is exactly the same in both configurations.
   • Check if the IP address is allowed to access Unomi.
   • Ensure that the target context is correctly registered.

2. Connection Issues

   • Ensure that the Unomi service is running and network reachable.
   • Check the firewall settings to ensure that the port is not blocked.

3. Configuration Errors

   • Ensure that all required environment variables are correctly set.
   • Verify that the profileId matches the user record in Unomi.

Advanced Topics

Security Best Practices

• Enable UNOMI_KEY for encrypted communication in a production environment.
• Use HTTPS to protect communication with Unomi.
• Regularly rotate keys and monitor unauthorized access attempts.

Logging and Monitoring

• Use log management tools (such as the ELK stack) to centrally handle the logs of the MCP server.
• Monitor key metrics, such as request success rate and latency.

Example Configuration

Here is a complete example of package.json:

{
  "name": "mcp-unomi-server",
  "version": "1.0.0",
  "scripts": {
    "start": "npx @inoyu/mcp-unomi-server"
  },
  "dependencies": {
    "@inoyu/mcp-unomi-server": "^0.1.0"
  }
}

Conclusion

With this document, you should be able to successfully configure and run the Inoyu MCP Unomi Server. If you still have questions or encounter issues, please refer to the MCP Protocol Documentation or contact community support.