Skip to content
Back to search

MiniMax-MCP-JS

Official MiniMax Model Context Protocol (MCP) JavaScript implementation that provides seamless integration with MiniMax's powerful AI capabilities including image generation, video generation, text-to-speech, and voice cloning APIs.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/minimax-ai--minimax-mcp-js/badge.svg)](/listings/minimax-ai--minimax-mcp-js)

HTML

<a href="/listings/minimax-ai--minimax-mcp-js"><img src="/api/listings/minimax-ai--minimax-mcp-js/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Installing via Smithery

To install MiniMax MCP JS for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@MiniMax-AI/MiniMax-MCP-JS):

npx -y @smithery/cli install @MiniMax-AI/MiniMax-MCP-JS --client claude

Installing manually

# Install with pnpm (recommended)
pnpm add minimax-mcp-js

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 431 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. ![export](https://github.com/MiniMax-AI/MiniMax-01/raw/main/figures/MiniMaxLogo-Light.png)
  2. <div align="center">
  3. # MiniMax MCP JS
  4. JavaScript/TypeScript implementation of MiniMax MCP, providing image generation, video generation, text-to-speech, and more.
  5. <div style="line-height: 1.5;">
  6. <a href="https://www.minimax.io" target="_blank" style="margin: 2px; color: var(--fgColor-default);">
  7. <img alt="Homepage" src="https://img.shields.io/badge/_Homepage-MiniMax-FF4040?style=flat-square&labelColor=2C3E50&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgNDkwLjE2IDQxMS43Ij48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2ZmZjt9PC9zdHlsZT48L2RlZnM+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMjMzLjQ1LDQwLjgxYTE3LjU1LDE3LjU1LDAsMSwwLTM1LjEsMFYzMzEuNTZhNDAuODIsNDAuODIsMCwwLDEtODEuNjMsMFYxNDVhMTcuNTUsMTcuNTUsMCwxLDAtMzUuMDksMHY3OS4wNmE0MC44Miw0MC44MiwwLDAsMS04MS42MywwVjE5NS40MmExMS42MywxMS42MywwLDAsMSwyMy4yNiwwdjI4LjY2YTE3LjU1LDE3LjU1LDAsMCwwLDM1LjEsMFYxNDVBNDAuODIsNDAuODIsMCwwLDEsMTQwLDE0NVYzMzEuNTZhMTcuNTUsMTcuNTUsMCwwLDAsMzUuMSwwVjIxNy41aDBWNDAuODFhNDAuODEsNDAuODEsMCwxLDEsODEuNjIsMFYyODEuNTZhMTEuNjMsMTEuNjMsMCwxLDEtMjMuMjYsMFptMjE1LjksNjMuNEE0MC44Niw0MC44NiwwLDAsMCw0MDguNTMsMTQ1VjMwMC44NWExNy41NSwxNy41NSwwLDAsMS0zNS4wOSwwdi0yNjBhNDAuODIsNDAuODIsMCwwLDAtODEuNjMsMFYzNzAuODlhMTcuNTUsMTcuNTUsMCwwLDEtMzUuMSwwVjMzMGExMS42MywxMS42MywwLDEsMC0yMy4yNiwwdjQwLjg2YTQwLjgxLDQwLjgxLDAsMCwwLDgxLjYyLDBWNDAuODFhMTcuNTUsMTcuNTUsMCwwLDEsMzUuMSwwdjI2MGE0MC44Miw0MC44MiwwLDAsMCw4MS42MywwVjE0NWExNy41NSwxNy41NSwwLDEsMSwzNS4xLDBWMjgxLjU2YTExLjYzLDExLjYzLDAsMCwwLDIzLjI2LDBWMTQ1QTQwLjg1LDQwLjg1LDAsMCwwLDQ0OS4zNSwxMDQuMjFaIi8+PC9zdmc+&logoWidth=20" style="display: inline-block; vertical-align: middle;"/>
  8. </a>
  9. <a href="https://arxiv.org/abs/2501.08313" target="_blank" style="margin: 2px;">
  10. <img alt="Paper" src="https://img.shields.io/badge/📖_Paper-MiniMax--01-FF4040?style=flat-square&labelColor=2C3E50" style="display: inline-block; vertical-align: middle;"/>
  11. </a>
  12. <a href="https://chat.minimax.io/" target="_blank" style="margin: 2px;">
  13. <img alt="Chat" src="https://img.shields.io/badge/_MiniMax_Chat-FF4040?style=flat-square&labelColor=2C3E50&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2aWV3Qm94PSIwIDAgNDkwLjE2IDQxMS43Ij48ZGVmcz48c3R5bGU+LmNscy0xe2ZpbGw6I2ZmZjt9PC9zdHlsZT48L2RlZnM+PHBhdGggY2xhc3M9ImNscy0xIiBkPSJNMjMzLjQ1LDQwLjgxYTE3LjU1LDE3LjU1LDAsMSwwLTM1LjEsMFYzMzEuNTZhNDAuODIsNDAuODIsMCwwLDEtODEuNjMsMFYxNDVhMTcuNTUsMTcuNTUsMCwxLDAtMzUuMDksMHY3OS4wNmE0MC44Miw0MC44MiwwLDAsMS04MS42MywwVjE5NS40MmExMS42MywxMS42MywwLDAsMSwyMy4yNiwwdjI4LjY2YTE3LjU1LDE3LjU1LDAsMCwwLDM1LjEsMFYxNDVBNDAuODIsNDAuODIsMCwwLDEsMTQwLDE0NVYzMzEuNTZhMTcuNTUsMTcuNTUsMCwwLDAsMzUuMSwwVjIxNy41aDBWNDAuODFhNDAuODEsNDAuODEsMCwxLDEsODEuNjIsMFYyODEuNTZhMTEuNjMsMTEuNjMsMCwxLDEtMjMuMjYsMFptMjE1LjksNjMuNEE0MC44Niw0MC44NiwwLDAsMCw0MDguNTMsMTQ1VjMwMC44NWExNy41NSwxNy41NSwwLDAsMS0zNS4wOSwwdi0yNjBhNDAuODIsNDAuODIsMCwwLDAtODEuNjMsMFYzNzAuODlhMTcuNTUsMTcuNTUsMCwwLDEtMzUuMSwwVjMzMGExMS42MywxMS42MywwLDEsMC0yMy4yNiwwdjQwLjg2YTQwLjgxLDQwLjgxLDAsMCwwLDgxLjYyLDBWNDAuODFhMTcuNTUsMTcuNTUsMCwwLDEsMzUuMSwwdjI2MGE0MC44Miw0MC44MiwwLDAsMCw4MS42MywwVjE0NWExNy41NSwxNy41NSwwLDEsMSwzNS4xLDBWMjgxLjU2YTExLjYzLDExLjYzLDAsMCwwLDIzLjI2LDBWMTQ1QTQwLjg1LDQwLjg1LDAsMCwwLDQ0OS4zNSwxMDQuMjFaIi8+PC9zdmc+&logoWidth=20" style="display: inline-block; vertical-align: middle;"/>
  14. </a>
  15. <a href="https://www.minimax.io/platform" style="margin: 2px;">
  16. <img alt="API" src="https://img.shields.io/badge/⚡_API-Platform-FF4040?style=flat-square&labelColor=2C3E50" style="display: inline-block; vertical-align: middle;"/>
  17. </a>
  18. </div>
  19. <div style="line-height: 1.5;">
  20. <a href="https://huggingface.co/MiniMaxAI" target="_blank" style="margin: 2px;">
  21. <img alt="Hugging Face" src="https://img.shields.io/badge/🤗_Hugging_Face-MiniMax-FF4040?style=flat-square&labelColor=2C3E50" style="display: inline-block; vertical-align: middle;"/>
  22. </a>
  23. <a href="https://github.com/MiniMax-AI/MiniMax-AI.github.io/blob/main/images/wechat-qrcode.jpeg" target="_blank" style="margin: 2px;">
  24. <img alt="WeChat" src="https://img.shields.io/badge/_WeChat-MiniMax-FF4040?style=flat-square&labelColor=2C3E50" style="display: inline-block; vertical-align: middle;"/>
  25. </a>
  26. <a href="https://www.modelscope.cn/organization/MiniMax" target="_blank" style="margin: 2px;">
  27. <img alt="ModelScope" src="https://img.shields.io/badge/_ModelScope-MiniMax-FF4040?style=flat-square&labelColor=2C3E50" style="display: inline-block; vertical-align: middle;"/>
  28. </a>
  29. </div>
  30. <div style="line-height: 1.5;">
  31. <a href="https://github.com/MiniMax-AI/MiniMax-MCP-JS/blob/main/LICENSE" style="margin: 2px;">
  32. <img alt="Code License" src="https://img.shields.io/badge/_Code_License-MIT-FF4040?style=flat-square&labelColor=2C3E50" style="display: inline-block; vertical-align: middle;"/>
  33. </a>
  34. <a href="https://smithery.ai/server/@MiniMax-AI/MiniMax-MCP-JS"><img alt="Smithery Badge" src="https://smithery.ai/badge/@MiniMax-AI/MiniMax-MCP-JS"></a>
  35. </div>
  36. </div>
  37. ## Documentation
  38. - [中文文档](README.zh-CN.md)
  39. - [Python Version](https://github.com/MiniMax-AI/MiniMax-MCP) - Official Python implementation of MiniMax MCP
  40. ## Release Notes
  41. ### July 22, 2025
  42. #### 🔧 Fixes & Improvements
  43. - **TTS Tool Fixes**: Fixed parameter handling for `languageBoost` and `subtitleEnable` in the `text_to_audio` tool
  44. - **API Response Enhancement**: TTS API can return both audio file and subtitle file, providing a more complete speech-to-text experience
  45. ### July 7, 2025
  46. #### 🆕 What's New
  47. - **Voice Design**: New `voice_design` tool - create custom voices from descriptive prompts with preview audio
  48. - **Video Enhancement**: Added `MiniMax-Hailuo-02` model with ultra-clear quality and duration/resolution controls
  49. #### 📈 Enhanced Tools
  50. - `voice_design` - Generate personalized voices from text descriptions
  51. - `generate_video` - Now supports MiniMax-Hailuo-02 with 6s/10s duration and 768P/1080P resolution options
  52. ## Features
  53. - Text-to-Speech (TTS)
  54. - Image Generation
  55. - Video Generation
  56. - Voice Cloning
  57. - Voice Design
  58. - Dynamic configuration (supports both environment variables and request parameters)
  59. - Compatible with MCP platform hosting (ModelScope and other MCP platforms)
  60. ## Installation
  61. ### Installing via Smithery
  62. To install MiniMax MCP JS for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@MiniMax-AI/MiniMax-MCP-JS):
  63. ```bash
  64. npx -y @smithery/cli install @MiniMax-AI/MiniMax-MCP-JS --client claude
  65. ```
  66. ### Installing manually
  67. ```bash
  68. # Install with pnpm (recommended)
  69. pnpm add minimax-mcp-js
  70. ```
  71. ## Quick Start
  72. MiniMax MCP JS implements the [Model Context Protocol (MCP)](https://github.com/anthropics/model-context-protocol) specification and can be used as a server to interact with MCP-compatible clients (such as Claude AI).
  73. ### Quickstart with MCP Client
  74. 1. Get your API key from [MiniMax International Platform](https://www.minimax.io/platform/user-center/basic-information/interface-key).
  75. 2. Make sure that you already installed [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
  76. 3. **Important: API HOST&KEY are different in different region**, they must match, otherwise you will receive an `Invalid API key` error.
  77. |Region| Global | Mainland |
  78. |:--|:-----|:-----|
  79. |MINIMAX_API_KEY| go get from [MiniMax Global](https://www.minimax.io/platform/user-center/basic-information/interface-key) | go get from [MiniMax](https://platform.minimaxi.com/user-center/basic-information/interface-key) |
  80. |MINIMAX_API_HOST| ​https://api.minimaxi.chat (note the extra **"i"**) | ​https://api.minimax.chat |
  81. ### Using with MCP Clients (Recommended)
  82. Configure your MCP client:
  83. #### Claude Desktop
  84. Go to `Claude > Settings > Developer > Edit Config > claude_desktop_config.json` to include:
  85. ```json
  86. {
  87. "mcpServers": {
  88. "minimax-mcp-js": {
  89. "command": "npx",
  90. "args": [
  91. "-y",
  92. "minimax-mcp-js"
  93. ],
  94. "env": {
  95. "MINIMAX_API_HOST": "<https://api.minimaxi.chat|https://api.minimax.chat>",
  96. "MINIMAX_API_KEY": "<your-api-key-here>",
  97. "MINIMAX_MCP_BASE_PATH": "<local-output-dir-path, such as /User/xxx/Desktop>",
  98. "MINIMAX_RESOURCE_MODE": "<optional, [url|local], url is default, audio/image/video are downloaded locally or provided in URL format>"
  99. }
  100. }
  101. }
  102. }
  103. ```
  104. #### Cursor
  105. Go to `Cursor → Preferences → Cursor Settings → MCP → Add new global MCP Server` to add the above config.
  106. ⚠️ **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](https://forum.cursor.com/t/mcp-servers-no-tools-found/49094/23).
  107. That's it. Your MCP client can now interact with MiniMax through these tools.
  108. **For local development**:
  109. When developing locally, you can use `npm link` to test your changes:
  110. ```bash
  111. # In your project directory
  112. npm link
  113. ```
  114. Then configure Claude Desktop or Cursor to use npx as shown above. This will automatically use your linked version.
  115. ⚠️ **Note**: The API key needs to match the host address. Different hosts are used for global and mainland China versions:
  116. - Global Host: `https://api.minimaxi.chat` (note the extra "i")
  117. - Mainland China Host: `https://api.minimaxi.chat`
  118. ## Transport Modes
  119. MiniMax MCP JS supports three transport modes:
  120. | Feature | stdio (default) | REST | SSE |
  121. |:-----|:-----|:-----|:-----|
  122. | Environment | Local only | Local or cloud deployment | Local or cloud deployment |
  123. | Communication | Via `standard I/O` | Via `HTTP requests` | Via `server-sent events` |
  124. | Use Cases | Local MCP client integration | API services, cross-language calls | Applications requiring server push |
  125. | Input Restrictions | Supports `local files` or `URL` resources | When deployed in cloud, `URL` input recommended | When deployed in cloud, `URL` input recommended |
  126. ## Configuration
  127. MiniMax-MCP-JS provides multiple flexible configuration methods to adapt to different use cases. The configuration priority from highest to lowest is as follows:
  128. ### 1. Request Parameter Configuration (Highest Priority)
  129. 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:
  130. ```json
  131. {
  132. "params": {
  133. "meta": {
  134. "auth": {
  135. "api_key": "your_api_key_here",
  136. "api_host": "<https://api.minimaxi.chat|https://api.minimaxi.chat>",
  137. "base_path": "/path/to/output",
  138. "resource_mode": "url"
  139. }
  140. }
  141. }
  142. }
  143. ```
  144. This method enables multi-tenant usage, where each request can use different API keys and configurations.
  145. ### 2. API Configuration
  146. When used as a module in other projects, you can pass configuration through the `startMiniMaxMCP` function:
  147. ```javascript
  148. import { startMiniMaxMCP } from 'minimax-mcp-js';
  149. await startMiniMaxMCP({
  150. apiKey: 'your_api_key_here',
  151. apiHost: 'https://api.minimaxi.chat', // Global Host - https://api.minimaxi.chat, Mainland Host - https://api.minimax.chat
  152. basePath: '/path/to/output',
  153. resourceMode: 'url'
  154. });
  155. ```
  156. ### 3. Command Line Arguments
  157. 1. Install the CLI tool globally:
  158. ```bash
  159. # Install globally
  160. pnpm install -g minimax-mcp-js
  161. ```
  162. 2. When used as a CLI tool, you can provide configuration via command line arguments:
  163. ```bash
  164. minimax-mcp-js --api-key your_api_key_here --api-host https://api.minimaxi.chat --base-path /path/to/output --resource-mode url
  165. ```
  166. ### 4. Environment Variables (Lowest Priority)
  167. The most basic configuration method is through environment variables:
  168. ```bash
  169. # MiniMax API Key (required)
  170. MINIMAX_API_KEY=your_api_key_here
  171. # Base path for output files (optional, defaults to user's desktop)
  172. MINIMAX_MCP_BASE_PATH=~/Desktop
  173. # MiniMax API Host (optional, defaults to https://api.minimaxi.chat, Global Host - https://api.minimaxi.chat, Mainland Host - https://api.minimax.chat)
  174. MINIMAX_API_HOST=https://api.minimaxi.chat
  175. # Resource mode (optional, defaults to 'url')
  176. # Options: 'url' (return URLs), 'local' (save files locally)
  177. MINIMAX_RESOURCE_MODE=url
  178. ```
  179. ### Configuration Priority
  180. When multiple configuration methods are used, the following priority order applies (from highest to lowest):
  181. 1. **Request-level configuration** (via `meta.auth` in each API request)
  182. 2. **Command line arguments**
  183. 3. **Environment variables**
  184. 4. **Configuration file**
  185. 5. **Default values**
  186. This prioritization ensures flexibility across different deployment scenarios while maintaining per-request configuration capabilities for multi-tenant environments.
  187. ### Configuration Parameters
  188. | Parameter | Description | Default Value |
  189. |-----------|-------------|---------------|
  190. | apiKey | MiniMax API Key | None (Required) |
  191. | apiHost | MiniMax API Host | Global Host - https://api.minimaxi.chat, Mainland Host - https://api.minimax.chat |
  192. | basePath | Base path for output files | User's desktop |
  193. | resourceMode | Resource handling mode, 'url' or 'local' | url |
  194. ⚠️ **Note**: The API key needs to match the host address. Different hosts are used for global and mainland China versions:
  195. - Global Host: `https://api.minimaxi.chat` (note the extra "i")
  196. - Mainland China Host: `https://api.minimax.chat`
  197. ## Example usage
  198. ⚠️ Warning: Using these tools may incur costs.
  199. ### 1. broadcast a segment of the evening news
  200. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/Snipaste_2025-04-09_20-07-53.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  201. ### 2. clone a voice
  202. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/Snipaste_2025-04-09_19-45-13.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  203. ### 3. generate a video
  204. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/Snipaste_2025-04-09_19-58-52.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  205. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/Snipaste_2025-04-09_19-59-43.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle; "/>
  206. ### 4. generate images
  207. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/gen_image.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  208. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/gen_image1.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle; "/>
  209. ### 5. voice design
  210. <img src="https://filecdn.minimax.chat/public/5654f5df-0642-477f-9c5d-b853d185b8b0.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  211. ## Available Tools
  212. ### Text to Audio
  213. Convert text to speech audio file.
  214. Tool Name: `text_to_audio`
  215. Parameters:
  216. - `text`: Text to convert (required)
  217. - `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'
  218. - `voiceId`: Voice ID, default is 'male-qn-qingse'
  219. - `speed`: Speech speed, range 0.5-2.0, default is 1.0
  220. - `vol`: Volume, range 0.1-10.0, default is 1.0
  221. - `pitch`: Pitch, range -12 to 12, default is 0
  222. - `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
  223. - `format`: Audio format, options are 'mp3', 'pcm', 'flac', 'wav', default is 'mp3'
  224. - `sampleRate`: Sample rate (Hz), options are 8000, 16000, 22050, 24000, 32000, 44100, default is 32000
  225. - `bitrate`: Bitrate (bps), options are 64000, 96000, 128000, 160000, 192000, 224000, 256000, 320000, default is 128000
  226. - `channel`: Audio channels, options are 1 or 2, default is 1
  227. - `languageBoost`: Enhance the ability to recognize specified languages and dialects.
  228. Supported values include:
  229. 'Chinese', 'Chinese,Yue', 'English', 'Arabic', 'Russian', 'Spanish', 'French', 'Portuguese', 'German', 'Turkish', 'Dutch', 'Ukrainian', 'Vietnamese', 'Indonesian', 'Japanese', 'Italian', 'Korean', 'Thai', 'Polish', 'Romanian', 'Greek', 'Czech', 'Finnish', 'Hindi', 'auto', default is 'auto'
  230. - `stream`: Enable streaming output
  231. - `subtitleEnable`: The parameter controls whether the subtitle service is enabled. The model must be 'speech-01-turbo' or 'speech-01-hd'. If this parameter is not provided, the default value is false
  232. - `outputDirectory`: Directory to save the output file. `outputDirectory` is relative to `MINIMAX_MCP_BASE_PATH` (or `basePath` in config). The final save path is `${basePath}/${outputDirectory}`. For example, if `MINIMAX_MCP_BASE_PATH=~/Desktop` and `outputDirectory=workspace`, the output will be saved to `~/Desktop/workspace/`. (optional)
  233. - `outputFile`: Path to save the output file (optional, auto-generated if not provided)
  234. ### Play Audio
  235. Play an audio file. Supports WAV and MP3 formats. Does not support video.
  236. Tool Name: `play_audio`
  237. Parameters:
  238. - `inputFilePath`: Path to the audio file to play (required)
  239. - `isUrl`: Whether the audio file is a URL, default is false
  240. ### Voice Clone
  241. Clone a voice from an audio file.
  242. Tool Name: `voice_clone`
  243. Parameters:
  244. - `audioFile`: Path to audio file (required)
  245. - `voiceId`: Voice ID (required)
  246. - `text`: Text for demo audio (optional)
  247. - `outputDirectory`: Directory to save the output file. `outputDirectory` is relative to `MINIMAX_MCP_BASE_PATH` (or `basePath` in config). The final save path is `${basePath}/${outputDirectory}`. For example, if `MINIMAX_MCP_BASE_PATH=~/Desktop` and `outputDirectory=workspace`, the output will be saved to `~/Desktop/workspace/`. (optional)
  248. ### Text to Image
  249. Generate images based on text prompts.
  250. Tool Name: `text_to_image`
  251. Parameters:
  252. - `prompt`: Image description (required)
  253. - `model`: Model version, default is 'image-01'
  254. - `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'
  255. - `n`: Number of images to generate, range 1-9, default is 1
  256. - `promptOptimizer`: Whether to optimize the prompt, default is true
  257. - `subjectReference`: Path to local image file or public URL for character reference (optional)
  258. - `outputDirectory`: Directory to save the output file. `outputDirectory` is relative to `MINIMAX_MCP_BASE_PATH` (or `basePath` in config). The final save path is `${basePath}/${outputDirectory}`. For example, if `MINIMAX_MCP_BASE_PATH=~/Desktop` and `outputDirectory=workspace`, the output will be saved to `~/Desktop/workspace/`. (optional)
  259. - `outputFile`: Path to save the output file (optional, auto-generated if not provided)
  260. - `asyncMode`: Whether to use async mode. Defaults to False. If True, the video generation task will be submitted asynchronously and the response will return a task_id. Should use `query_video_generation` tool to check the status of the task and get the result. (optional)
  261. ### Generate Video
  262. Generate videos based on text prompts.
  263. Tool Name: `generate_video`
  264. Parameters:
  265. - `prompt`: Video description (required)
  266. - `model`: Model version, options are 'T2V-01', 'T2V-01-Director', 'I2V-01', 'I2V-01-Director', 'I2V-01-live', 'S2V-01', 'MiniMax-Hailuo-02', default is 'MiniMax-Hailuo-02'
  267. - `firstFrameImage`: Path to first frame image (optional)
  268. - `duration`: The duration of the video. The model must be "MiniMax-Hailuo-02". Values can be 6 and 10. (optional)
  269. - `resolution`: The resolution of the video. The model must be "MiniMax-Hailuo-02". Values range ["768P", "1080P"]. (optional)
  270. - `outputDirectory`: Directory to save the output file. `outputDirectory` is relative to `MINIMAX_MCP_BASE_PATH` (or `basePath` in config). The final save path is `${basePath}/${outputDirectory}`. For example, if `MINIMAX_MCP_BASE_PATH=~/Desktop` and `outputDirectory=workspace`, the output will be saved to `~/Desktop/workspace/`. (optional)
  271. - `outputFile`: Path to save the output file (optional, auto-generated if not provided)
  272. - `asyncMode`: Whether to use async mode. Defaults to False. If True, the video generation task will be submitted asynchronously and the response will return a task_id. Should use `query_video_generation` tool to check the status of the task and get the result. (optional)
  273. ### Query Video Generation Status
  274. Query the status of a video generation task.
  275. Tool Name: `query_video_generation`
  276. Parameters:
  277. - `taskId`: The Task ID to query. Should be the task_id returned by `generate_video` tool if `async_mode` is True. (required)
  278. - `outputDirectory`: Directory to save the output file. `outputDirectory` is relative to `MINIMAX_MCP_BASE_PATH` (or `basePath` in config). The final save path is `${basePath}/${outputDirectory}`. For example, if `MINIMAX_MCP_BASE_PATH=~/Desktop` and `outputDirectory=workspace`, the output will be saved to `~/Desktop/workspace/`. (optional)
  279. ### Voice Design
  280. Generate a voice based on description prompts.
  281. Tool Name: `voice_design`
  282. Parameters:
  283. - `prompt`: The prompt to generate the voice from. (required)
  284. - `previewText`: The text to preview the voice. (required)
  285. - `voiceId`: The id of the voice to use. For example, "male-qn-qingse"/"audiobook_female_1"/"cute_boy"/"Charming_Lady"... (optional)
  286. - `outputDirectory`: The directory to save the output file. `outputDirectory` is relative to `MINIMAX_MCP_BASE_PATH` (or `basePath` in config). The final save path is `${basePath}/${outputDirectory}`. For example, if `MINIMAX_MCP_BASE_PATH=~/Desktop` and `outputDirectory=workspace`, the output will be saved to `~/Desktop/workspace/`. (optional)
  287. ## FAQ
  288. ### 1. How to use `generate_video` in async-mode
  289. Define completion rules before starting:
  290. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/cursor_rule2.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  291. Alternatively, these rules can be configured in your IDE settings (e.g., Cursor):
  292. <img src="https://public-cdn-video-data-algeng.oss-cn-wulanchabu.aliyuncs.com/cursor_video_rule.png?x-oss-process=image/resize,p_50/format,webp" style="display: inline-block; vertical-align: middle;"/>
  293. ## Development
  294. ### Setup
  295. ```bash
  296. # Clone the repository
  297. git clone https://github.com/MiniMax-AI/MiniMax-MCP-JS.git
  298. cd minimax-mcp-js
  299. # Install dependencies
  300. pnpm install
  301. ```
  302. ### Build
  303. ```bash
  304. # Build the project
  305. pnpm run build
  306. ```
  307. ### Run
  308. ```bash
  309. # Run the MCP server
  310. pnpm start
  311. ```
  312. ## License
  313. MIT

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.