Particle MCP Server

🚀 Particle MCP Server

A Model Context Protocol server for the Particle IoT platform, enabling AI assistants to manage Particle devices via natural language.

🚀 Quick Start

✨ Features

This server offers a wide range of API interfaces to interact with the Particle IoT platform. Here's an overview of the features and their corresponding API endpoints:

Devices

• list_devices: List all devices under your account.
• list_product_devices: List all devices within a specified product.
• rename_device: Rename a device while keeping its node ID unchanged.
• add_device_notes: Add notes to a specific device.
• ping_device: Check if a device is online.
• call_function: Call a specified function on a specific device.

Diagnostics

• get_device_vitals: Retrieve the latest known health data of a specific device.

Organizations

• list_organizations: List all organizations you're involved in.
• list_organization_products: List all products within an organization.

Product Firmware

• list_product_firmware: List all firmware versions for a specific product ID.

📦 Installation

1. Create a .env file with the following structure:

# Particle API credentials
PARTICLE_ACCESS_TOKEN = your_api_token

2. To generate a Particle API token, make sure the Particle CLI is installed and run the following command:

particle token create

💻 Usage Examples

Basic Usage

1. Clone this repository.
2. Open Claude Desktop.
3. Navigate to the settings menu.
4. Click on the developer options.
5. Click on "Edit Configuration".
6. Paste the following content:

{
    "mcpServers": {
        "particle": {
            "command": "uv",
            "args": [
                "--directory",
                "DIRECT/PATH/TO/particle-mcp-server",
                "run",
                "particle.py"
            ]
        }
    }
}

🤝 Contribution Guidelines

To contribute to this project, follow the steps below:

1. Refer to the Particle API documentation to set up the Particle API environment in Postman.
2. Implement a tool for each API endpoint.
3. Submit a Pull Request (PR) with your changes. Keep your PRs small and focused for easier review.