minimax multimodal.com
minimax multimodal.com logo

MiniMax Multimodal

Official JavaScript implementation that integrates with MiniMax's multimodal capabilities for image generation, video cr...

Created byApr 22, 2025
export

MiniMax MCP JS

JavaScript/TypeScript implementation of MiniMax MCP, providing image generation, video generation, text-to-speech, and more.

Documentation

Features

  • Text-to-Speech (TTS)
  • Image Generation
  • Video Generation
  • Voice Cloning
  • Dynamic configuration (supports both environment variables and request parameters)
  • Compatible with MCP platform hosting (ModelScope and other MCP platforms)

Installation

Quick Start

MiniMax MCP JS implements the Model Context Protocol (MCP) specification and can be used as a server to interact with MCP-compatible clients (such as Claude AI).

Quickstart with MCP Client

  1. Get your API key from MiniMax International Platform.
  1. Install minimax-mcp-js using pnpm: pnpm add minimax-mcp-js
  1. Important: API HOST&KEY are different in different region, they must match, otherwise you will receive an Invalid API key error.
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]

Using with MCP Clients (Recommended)

  1. Install the CLI tool globally:
  1. Configure your MCP client:

Claude Desktop

Go to Claude > Settings > Developer > Edit Config > claude_desktop_config.json to include:

Cursor

Go to Cursor Preferences Cursor Settings MCP Add new global MCP Server to add the above config.
Note: If you encounter a "No tools found" error when using MiniMax MCP JS with Cursor, please update your Cursor to the latest version. For more information, see this discussion thread.
That's it. Your MCP client can now interact with MiniMax through these tools.
For local development: When developing locally, you can use npm link to test your changes:
Then configure Claude Desktop or Cursor to use npx as shown above. This will automatically use your linked version.
Note: The API key needs to match the host address. Different hosts are used for global and mainland China versions:
  • Global Host: https://api.minimaxi.chat (note the extra "i")
  • Mainland China Host: https://api.minimaxi.chat

Transport Modes

MiniMax MCP JS supports three transport modes:
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]

Configuration

MiniMax-MCP-JS provides multiple flexible configuration methods to adapt to different use cases. The configuration priority from highest to lowest is as follows:

1. Request Parameter Configuration (Highest Priority)

In platform hosting environments (like ModelScope or other MCP platforms), you can provide an independent configuration for each request via the meta.auth object in the request parameters:
This method enables multi-tenant usage, where each request can use different API keys and configurations.

2. API Configuration

When used as a module in other projects, you can pass configuration through the startMiniMaxMCP function:

3. Command Line Arguments

When used as a CLI tool, you can provide configuration via command line arguments:

4. Environment Variables (Lowest Priority)

The most basic configuration method is through environment variables:

Configuration Priority

When multiple configuration methods are used, the following priority order applies (from highest to lowest):
  1. Request-level configuration (via meta.auth in each API request)
  1. Command line arguments
  1. Environment variables
  1. Configuration file
  1. Default values
This prioritization ensures flexibility across different deployment scenarios while maintaining per-request configuration capabilities for multi-tenant environments.

Configuration Parameters

[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
Note: The API key needs to match the host address. Different hosts are used for global and mainland China versions:
  • Global Host: https://api.minimaxi.chat (note the extra "i")
  • Mainland China Host: https://api.minimaxi.chat

Example usage

Warning: Using these tools may incur costs.

1. broadcast a segment of the evening news

2. clone a voice

3. generate a video

4. generate images

Available Tools

Text to Audio

Convert text to speech audio file.
Tool Name: text_to_audio
Parameters:
  • text: Text to convert (required)
  • model: Model version, options are 'speech-02-hd', 'speech-02-turbo', 'speech-01-hd', 'speech-01-turbo', 'speech-01-240228', 'speech-01-turbo-240228', default is 'speech-02-hd'
  • voiceId: Voice ID, default is 'male-qn-qingse'
  • speed: Speech speed, range 0.5-2.0, default is 1.0
  • vol: Volume, range 0.1-10.0, default is 1.0
  • pitch: Pitch, range -12 to 12, default is 0
  • emotion: Emotion, options are 'happy', 'sad', 'angry', 'fearful', 'disgusted', 'surprised', 'neutral', default is 'happy'. Note: This parameter only works with 'speech-02-hd', 'speech-02-turbo', 'speech-01-turbo', 'speech-01-hd' models
  • format: Audio format, options are 'mp3', 'pcm', 'flac', 'wav', default is 'mp3'
  • sampleRate: Sample rate (Hz), options are 8000, 16000, 22050, 24000, 32000, 44100, default is 32000
  • bitrate: Bitrate (bps), options are 64000, 96000, 128000, 160000, 192000, 224000, 256000, 320000, default is 128000
  • channel: Audio channels, options are 1 or 2, default is 1
  • languageBoost: Language boost, default is 'auto'
  • latexRead: Enable LaTeX formula reading
  • pronunciationDict: Pronunciation dictionary
  • stream: Enable streaming output
  • subtitleEnable: Enable subtitle generation
  • outputDirectory: Directory to save the output file (optional)
  • outputFile: Path to save the output file (optional, auto-generated if not provided)

Text to Image

Generate images based on text prompts.
Tool Name: text_to_image
Parameters:
  • prompt: Image description (required)
  • model: Model version, default is 'image-01'
  • aspectRatio: Aspect ratio, default is '1:1', options are '1:1', '16:9','4:3', '3:2', '2:3', '3:4', '9:16', '21:9'
  • n: Number of images to generate, range 1-9, default is 1
  • promptOptimizer: Whether to optimize the prompt, default is true
  • subjectReference: Path to local image file or public URL for character reference (optional)
  • outputDirectory: Directory to save the output file (optional)
  • outputFile: Path to save the output file (optional, auto-generated if not provided)

Generate Video

Generate videos based on text prompts.
Tool Name: generate_video
Parameters:
  • prompt: Video description (required)
  • model: Model version, options are 'T2V-01', 'T2V-01-Director', 'I2V-01', 'I2V-01-Director', 'I2V-01-live', 'S2V-01', default is 'T2V-01'
  • firstFrameImage: Path to first frame image (optional)
  • outputDirectory: Directory to save the output file (optional)
  • outputFile: Path to save the output file (optional, auto-generated if not provided)

Voice Clone

Clone a voice from an audio file.
Tool Name: voice_clone
Parameters:
  • audioFile: Path to audio file (required)
  • voiceId: Voice ID (required)
  • text: Text for demo audio (optional)
  • outputDirectory: Directory to save the output file (optional)

Development

Setup

Build

Run

License

MIT
export

MiniMax MCP JS

JavaScript/TypeScript implementation of MiniMax MCP, providing image generation, video generation, text-to-speech, and more.

Documentation

Features

  • Text-to-Speech (TTS)
  • Image Generation
  • Video Generation
  • Voice Cloning
  • Dynamic configuration (supports both environment variables and request parameters)
  • Compatible with MCP platform hosting (ModelScope and other MCP platforms)

Installation

Quick Start

MiniMax MCP JS implements the Model Context Protocol (MCP) specification and can be used as a server to interact with MCP-compatible clients (such as Claude AI).

Quickstart with MCP Client

  1. Get your API key from MiniMax International Platform.
  1. Install minimax-mcp-js using pnpm: pnpm add minimax-mcp-js
  1. Important: API HOST&KEY are different in different region, they must match, otherwise you will receive an Invalid API key error.
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]

Using with MCP Clients (Recommended)

  1. Install the CLI tool globally:
  1. Configure your MCP client:

Claude Desktop

Go to Claude > Settings > Developer > Edit Config > claude_desktop_config.json to include:

Cursor

Go to Cursor Preferences Cursor Settings MCP Add new global MCP Server to add the above config.
Note: If you encounter a "No tools found" error when using MiniMax MCP JS with Cursor, please update your Cursor to the latest version. For more information, see this discussion thread.
That's it. Your MCP client can now interact with MiniMax through these tools.
For local development: When developing locally, you can use npm link to test your changes:
Then configure Claude Desktop or Cursor to use npx as shown above. This will automatically use your linked version.
Note: The API key needs to match the host address. Different hosts are used for global and mainland China versions:
  • Global Host: https://api.minimaxi.chat (note the extra "i")
  • Mainland China Host: https://api.minimaxi.chat

Transport Modes

MiniMax MCP JS supports three transport modes:
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]

Configuration

MiniMax-MCP-JS provides multiple flexible configuration methods to adapt to different use cases. The configuration priority from highest to lowest is as follows:

1. Request Parameter Configuration (Highest Priority)

In platform hosting environments (like ModelScope or other MCP platforms), you can provide an independent configuration for each request via the meta.auth object in the request parameters:
This method enables multi-tenant usage, where each request can use different API keys and configurations.

2. API Configuration

When used as a module in other projects, you can pass configuration through the startMiniMaxMCP function:

3. Command Line Arguments

When used as a CLI tool, you can provide configuration via command line arguments:

4. Environment Variables (Lowest Priority)

The most basic configuration method is through environment variables:

Configuration Priority

When multiple configuration methods are used, the following priority order applies (from highest to lowest):
  1. Request-level configuration (via meta.auth in each API request)
  1. Command line arguments
  1. Environment variables
  1. Configuration file
  1. Default values
This prioritization ensures flexibility across different deployment scenarios while maintaining per-request configuration capabilities for multi-tenant environments.

Configuration Parameters

[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
[object Object]
Note: The API key needs to match the host address. Different hosts are used for global and mainland China versions:
  • Global Host: https://api.minimaxi.chat (note the extra "i")
  • Mainland China Host: https://api.minimaxi.chat

Example usage

Warning: Using these tools may incur costs.

1. broadcast a segment of the evening news

2. clone a voice

3. generate a video

4. generate images

Available Tools

Text to Audio

Convert text to speech audio file.
Tool Name: text_to_audio
Parameters:
  • text: Text to convert (required)
  • model: Model version, options are 'speech-02-hd', 'speech-02-turbo', 'speech-01-hd', 'speech-01-turbo', 'speech-01-240228', 'speech-01-turbo-240228', default is 'speech-02-hd'
  • voiceId: Voice ID, default is 'male-qn-qingse'
  • speed: Speech speed, range 0.5-2.0, default is 1.0
  • vol: Volume, range 0.1-10.0, default is 1.0
  • pitch: Pitch, range -12 to 12, default is 0
  • emotion: Emotion, options are 'happy', 'sad', 'angry', 'fearful', 'disgusted', 'surprised', 'neutral', default is 'happy'. Note: This parameter only works with 'speech-02-hd', 'speech-02-turbo', 'speech-01-turbo', 'speech-01-hd' models
  • format: Audio format, options are 'mp3', 'pcm', 'flac', 'wav', default is 'mp3'
  • sampleRate: Sample rate (Hz), options are 8000, 16000, 22050, 24000, 32000, 44100, default is 32000
  • bitrate: Bitrate (bps), options are 64000, 96000, 128000, 160000, 192000, 224000, 256000, 320000, default is 128000
  • channel: Audio channels, options are 1 or 2, default is 1
  • languageBoost: Language boost, default is 'auto'
  • latexRead: Enable LaTeX formula reading
  • pronunciationDict: Pronunciation dictionary
  • stream: Enable streaming output
  • subtitleEnable: Enable subtitle generation
  • outputDirectory: Directory to save the output file (optional)
  • outputFile: Path to save the output file (optional, auto-generated if not provided)

Text to Image

Generate images based on text prompts.
Tool Name: text_to_image
Parameters:
  • prompt: Image description (required)
  • model: Model version, default is 'image-01'
  • aspectRatio: Aspect ratio, default is '1:1', options are '1:1', '16:9','4:3', '3:2', '2:3', '3:4', '9:16', '21:9'
  • n: Number of images to generate, range 1-9, default is 1
  • promptOptimizer: Whether to optimize the prompt, default is true
  • subjectReference: Path to local image file or public URL for character reference (optional)
  • outputDirectory: Directory to save the output file (optional)
  • outputFile: Path to save the output file (optional, auto-generated if not provided)

Generate Video

Generate videos based on text prompts.
Tool Name: generate_video
Parameters:
  • prompt: Video description (required)
  • model: Model version, options are 'T2V-01', 'T2V-01-Director', 'I2V-01', 'I2V-01-Director', 'I2V-01-live', 'S2V-01', default is 'T2V-01'
  • firstFrameImage: Path to first frame image (optional)
  • outputDirectory: Directory to save the output file (optional)
  • outputFile: Path to save the output file (optional, auto-generated if not provided)

Voice Clone

Clone a voice from an audio file.
Tool Name: voice_clone
Parameters:
  • audioFile: Path to audio file (required)
  • voiceId: Voice ID (required)
  • text: Text for demo audio (optional)
  • outputDirectory: Directory to save the output file (optional)

Development

Setup

Build

Run

License

MIT