Faim Time Series Forecasting

by S-FM

344 downloads Not rated yet

About

An MCP server for zero-shot time-series forecasting powered by foundation models such as Chronos 2 and TiRex, with support for multivariate and probabilistic forecasts.

Explore

✅ Two MCP Tools:
- list_models: Returns available forecasting models and capabilities
- forecast: Performs point and probabilistic time series forecasting

✅ Flexible Input Formats:
- 1D arrays: Single univariate time series
- 3D arrays: batch/sequence/feature format

✅ Probabilistic Forecasting:
- Point forecasts (single value predictions)
- Quantile forecasts (confidence intervals)
- Sample forecasts (distribution samples)
- Custom quantile levels for risk assessment

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Faim Time Series Forecasting
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

- Node.js 20+
- npm 10+
- FAIM API key: Register at https://faim.it.com/ to get your FAIM_API_KEY

Configure your client to use it directly with npx:

{
  "mcpServers": {
    "faim": {
      "command": "npx",
      "args": ["-y", "@faim-group/mcp"],
      "env": {
        "FAIM_API_KEY": "your-api-key-here"
      }
    }
  }
}

No installation required - npx will automatically download and run the latest version.

Alternatively, if you prefer to install globally first:

npm install -g @faim-group/mcp

Then in config:

{
  "mcpServers": {
    "faim": {
      "command": "faim-mcp",
      "env": {
        "FAIM_API_KEY": "your-api-key-here"
      }
    }
  }
}

npm install

``bash

- [ ] Set FAIM_API_KEY environment variable
- [ ] Run
npm run build
- [ ] Run
npm test to verify
- [ ] Deploy
dist/ directory
- [ ] Run
node dist/index.js` as the server process

list_models

List all available forecasting models and their capabilities. Returns information about Chronos2, TiRex, and other available models, including supported output types and features.

forecast

Perform time series forecasting using FAIM platform. Supports both point forecasting (single value) and probabilistic forecasting (confidence intervals). Can handle univariate and multivariate time series data. Currently supported models: Chronos2 (default, recommended for multivariate) and TiRex (fast, univariate only).

Returns available forecasting models and their capabilities.

Request:

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/list",
"params": {}
}

Response:

{
"jsonrpc": "2.0",
"id": 1,
"result": {
"tools": [
{
"name": "list_models",
"description": "...",
"inputSchema": { ... }
},
{
"name": "forecast",
"description": "...",
"inputSchema": { ... }
}
]
}
}

Performs time series forecasting using FAIM models.

Request (Point Forecast):

{
"jsonrpc": "2.0",
"id": 2,
"method": "tools/call",
"params": {
"name": "forecast",
"arguments": {
"model": "chronos2",
"x": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
"horizon": 10,
"output_type": "point"
}
}
}

Request (Quantile Forecast with Confidence Intervals):

{
"jsonrpc": "2.0",
"id": 3,
"method": "tools/call",
"params": {
"name": "forecast",
"arguments": {
"model": "chronos2",
"x": [[[100, 50], [102, 51], [105, 52]]],
"horizon": 5,
"output_type": "quantiles",
"quantiles": [0.1, 0.5, 0.9]
}
}
}

Response:

{
"jsonrpc": "2.0",
"id": 2,
"result": {
"success": true,
"data": {
"model_name": "chronos2",
"model_version": "1.0",
"output_type": "point",
"forecast": {
"point": [[[11], [12], [13], ...]]
},
"metadata": {
"token_count": 150,
"duration_ms": 245
},
"shape_info": {
"input_shape": [1, 10, 1],
"output_shape": [1, 10, 1]
}
}
}
}

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "faim time series forecasting": {
            "faim": {
                "command": "npx",
                "args": [
                    "-y",
                    "@faim-group/mcp"
                ],
                "env": {
                    "FAIM_API_KEY": "your-api-key-here"
                }
            }
        }
    }
}

McpServers

{
    "faim": {
        "command": "npx",
        "args": [
            "-y",
            "@faim-group/mcp"
        ],
        "env": {
            "FAIM_API_KEY": "your-api-key-here"
        }
    }
}

FAIM MCP Server

npm version
License: MIT

A Model Context Protocol (MCP) server that integrates the FAIM time series forecasting SDK with any MCP-compatible AI assistant, enabling AI-powered forecasting capabilities.

NPM Package: @faim-group/mcp

Overview

This MCP server currently exposes two foundation time-series models from the FAIM API for zero-shot forecasting:
- Chronos2
- TiRex

Key Features

✅ Two MCP Tools:
- list_models: Returns available forecasting models and capabilities
- forecast: Performs point and probabilistic time series forecasting

✅ Flexible Input Formats:
- 1D arrays: Single univariate time series
- 3D arrays: batch/sequence/feature format

✅ Probabilistic Forecasting:
- Point forecasts (single value predictions)
- Quantile forecasts (confidence intervals)
- Sample forecasts (distribution samples)
- Custom quantile levels for risk assessment

Installation

Prerequisites

- Node.js 20+
- npm 10+
- FAIM API key: Register at https://faim.it.com/ to get your FAIM_API_KEY

Option 1: Install from npm (Recommended)

Configure your client to use it directly with npx:

{
  "mcpServers": {
    "faim": {
      "command": "npx",
      "args": ["-y", "@faim-group/mcp"],
      "env": {
        "FAIM_API_KEY": "your-api-key-here"
      }
    }
  }
}

No installation required - npx will automatically download and run the latest version.

Alternatively, if you prefer to install globally first:

npm install -g @faim-group/mcp

Then in config:

{
  "mcpServers": {
    "faim": {
      "command": "faim-mcp",
      "env": {
        "FAIM_API_KEY": "your-api-key-here"
      }
    }
  }
}

Option 2: Clone and Build Locally

```bash

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.