Pi Api MCP Server

🚀 PI API Connector Server

This is an MCP server implementation for connecting to the PI API. The documentation includes comprehensive instructions for installation, configuration, and usage.

🚀 Quick Start

This project provides a server implementation for connecting to the PI API. The following sections will guide you through installation, configuration, and usage.

✨ Features

• Connect to the PI API.
• Support for Docker deployment and direct execution.
• Provide detailed configuration examples for MCP clients.
• Offer various usage examples, including querying and creating data.

📦 Installation

Deploy with Docker

# Clone the repository (SSH or HTTPS)
git clone git@github.com:mingzilla/pi-api-mcp-server.git
cd pi-api-mcp-server

# Install dependencies
npm install
./dependencies.sh # Install global dependencies to support MCP clients connecting via "@mingzilla/pi-api-mcp-server"

# Build the project
npm run build

# Start the server
npm start

Direct Execution

# Install globally
npm install -g @mingzilla/pi-api-mcp-server

# Execute via npx
npx @mingzilla/pi-api-mcp-server --api-url "http://localhost:8224/pi/api/v2" --auth-token "XXXXXXXX"

MCP Client Configuration

Node.js Implementation

• Run the development server as described in the "Local Execution" section.
• Ensure that ./dependencies.sh has been executed to install the required global dependencies.
• Use the following configuration (Note: @mingzilla/pi-api-mcp-server refers to the package installed via "Local Execution").

{
  "mcpServers": {
    "pi-api": {
      "command": "npx",
      "args": [
        "-y",
        "@mingzilla/pi-api-mcp-server",
        "--api-url",
        "http://localhost:8224/pi/api/v2",
        "--auth-token",
        "XXXXXXXX"
      ],
      "autoApprove": [
        "keep-session-alive",
        "check-connection",
        "authenticate",
        "list-categories",
        "get-category",
        "list-charts",
        "get-chart",
        "export-chart",
        "get-filterable-attributes",
        "export-chart"
      ]
    }
  }
}

Docker Implementation

# Pull the image (example version)
docker pull mingzilla/pi-api-mcp-server:<VERSION>

# Run the container
docker run -it --name pi-api-mcp-server mingzilla/pi-api-mcp-server:<VERSION> --api-url "http://localhost:8224/pi/api/v2" --auth-token "XXXXXXXX"

Local Development

# Start the local server
./start.sh

Example configuration file:

{
  "mcpServers": {
    "pi-api": {
      "command": "node",
      "args": [
        "/home/mingzilla/dev/tool-mcp-pi-api-server/build/index.js",
        "--api-url",
        "http://localhost:8224/pi/api/v2",
        "--auth-token",
        "XXXXXXXX"
      ],
      "autoApprove": [
        "keep-session-alive",
        "check-connection",
        "authenticate",
        "list-categories",
        "get-category",
        "list-charts",
        "get-chart",
        "export-chart",
        "get-filterable-attributes",
        "export-chart"
      ]
    }
  }
}

💻 Usage Examples

Set Up the PI API Connector

# Install dependencies
npm install @mingzilla/pi-api-mcp-server

# Create a configuration file
vi config.json

Example Queries

The following are some common usage scenarios:

Query Category Data

curl -X GET "http://localhost:8224/categories"

Get a Single Category

curl -X GET "http://localhost:8224/categories/123"

Create a New Category

curl -X POST "http://localhost:8224/categories" -H "Content-Type: application/json" -d '{"name":"New Category"}'

📚 Documentation

Project Structure

pi-api-mcp-server/
├── src/                 # Source code directory
│   ├── index.js        # Entry file
│   └── routes/         # Route definitions
├── build/              # Build output directory
├── config/             # Configuration files
└── package.json       # Project dependencies and script configurations

Frequently Asked Questions

1. How to install dependencies? Use the following command to install all dependencies:

   npm install
   

2. How to start the server? After building the project, run:

   npm start
   

3. How to configure the server? Modify the config.json file and restart the server.

🤝 Contribution Guidelines

1. Fork the repository
2. Submit your code
3. Create a Pull Request

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

If you have any questions, please contact mingzilla@example.com.