# MiniMax Code Docs

- [Welcome to MiniMax Code](https://agent.minimax.io/docs/code/welcome.md): MiniMax Code is a desktop AI Agent app for software development, everyday workflows, automation, and remote collaboration.
- [Download and Install](https://agent.minimax.io/docs/code/get-started/download.md): Download MiniMax Code and install it on macOS or Windows.
- [Create Your First Task](https://agent.minimax.io/docs/code/get-started/first-task.md): Start from the composer, attach context, and let MiniMax Code begin working.
- [Coding and Work Modes](https://agent.minimax.io/docs/code/workflows/modes.md): Understand when to use Coding mode or Work mode in MiniMax Code.
- [Workspace and Project Context](https://agent.minimax.io/docs/code/workflows/workspace.md): Attach a local project so the Agent can understand your files, scripts, and conventions.
- [Tasks and History](https://agent.minimax.io/docs/code/workflows/tasks.md): Manage tasks, history, pinned items, and archived conversations in MiniMax Code.
- [Conversation Collaboration](https://agent.minimax.io/docs/code/workflows/conversation-collaboration.md): Quote, comment on, and rate Agent replies directly in a conversation.
- [Code Review](https://agent.minimax.io/docs/code/workflows/code-review.md): Use the built-in Review command to inspect local code changes.
- [Permissions and Safety](https://agent.minimax.io/docs/code/workflows/permissions.md): Understand how MiniMax Code handles permission prompts for local files, commands, and external actions.
- [Infinite Canvas](https://agent.minimax.io/docs/code/desktop/infinite-canvas.md): Bring your assets, ideas, and generated results onto one canvas, and create alongside your Agent.
- [Goal](https://agent.minimax.io/docs/code/desktop/goal.md): Set a verifiable outcome for MiniMax Code and let it keep working until the goal is achieved or progress is blocked.
- [Built-in Browser](https://agent.minimax.io/docs/code/desktop/browser.md): Open pages, preview generated HTML, and debug web work inside the MiniMax Code task view.
- [Computer Use](https://agent.minimax.io/docs/code/desktop/computer-use.md): Let MiniMax Code operate apps on your computer directly for tasks that need a graphical interface.
- [Files / Changes / Terminal Panels](https://agent.minimax.io/docs/code/desktop/panels.md): Use MiniMax Code panels to inspect files, code changes, and command output.
- [Appearance](https://agent.minimax.io/docs/code/desktop/appearance.md): Adjust the display mode, theme, density, fonts, and colors of MiniMax Code.
- [Shortcuts and Mini Window](https://agent.minimax.io/docs/code/desktop/shortcuts.md): Use global shortcuts, command palette, and the mini window to work faster.
- [Updates and Feedback](https://agent.minimax.io/docs/code/desktop/updates-feedback.md): Check for MiniMax Code updates and submit feedback tickets from the desktop app.
- [Agent Team](https://agent.minimax.io/docs/code/agents/team.md): Use Agent Team for complex tasks that benefit from decomposition, collaboration, and verification.
- [Custom Agents](https://agent.minimax.io/docs/code/agents/custom-agents.md): Create dedicated Agents with their own role, instructions, skills, workspace, and channels.
- [Mini Apps](https://agent.minimax.io/docs/code/agents/mini-apps.md): Bring information, tools, and everyday tasks together in one interface.
- [H3 Max Video Generation](https://agent.minimax.io/docs/code/agents/h3-max.md): Create videos with sound from text prompts and reference media in MiniMax Code.
- [Plugin Marketplace](https://agent.minimax.io/docs/code/agents/plugins.md): Install and use domain plugins in MiniMax Code.
- [Plugin Development and Submission Guide](https://agent.minimax.io/docs/code/agents/plugin-submission.md): Capability choices, package layout, manifest fields, Skills and MCP servers, size limits, and the submission process for MiniMax Plugins.
- [MCP Servers](https://agent.minimax.io/docs/code/agents/mcp.md): Connect external tools and data sources to MiniMax Code.
- [Memory](https://agent.minimax.io/docs/code/agents/memory.md): Let MiniMax Code retain useful preferences, project conventions, and long-term working patterns.
- [Scheduled Tasks](https://agent.minimax.io/docs/code/automation/schedules.md): Let Agents run recurring work on a schedule.
- [Remote Control](https://agent.minimax.io/docs/code/automation/remote-control.md): Connect to your desktop Agent from your phone to check progress, add instructions, and approve permissions.
- [Messaging Integrations](https://agent.minimax.io/docs/code/automation/im.md): Collaborate with Agents through Telegram, WeChat, Lark, or Feishu depending on the locale.
- [M Plan and Credits](https://agent.minimax.io/docs/code/account/usage.md): View your MiniMax Code subscription plan, credit balance, and usage quotas.
- [MiniMax API Key](https://agent.minimax.io/docs/code/account/minimax-api.md): Configure your own MiniMax API key in MiniMax Code.
- [Custom Models / BYOK](https://agent.minimax.io/docs/code/account/byok.md): Add a custom model provider with base URL, API key, API format, and model names.
- [Configure BYOK Models with an Agent](https://agent.minimax.io/docs/code/account/byok-agent-setup.md): Configure custom models with an agent and verify real responses using curl on macOS and Windows.
- [FAQ](https://agent.minimax.io/docs/code/help/faq.md): Frequently asked questions about MiniMax Code desktop.
- [Feedback](https://agent.minimax.io/docs/code/help/feedback.md): Submit reproduction details, screenshots, and diagnostics when reporting issues.
- [Quick Start](https://agent.minimax.io/docs/cli/quick-start.md): Install MiniMax Code CLI, sign in, and complete your first terminal task.
- [WebUI](https://agent.minimax.io/docs/cli/webui.md): Run MiniMax Code Web locally and use your browser to give instructions, follow progress, and approve permissions.
- [Features and configuration](https://agent.minimax.io/docs/cli/features.md): Learn about MiniMax Code CLI entry points, interactive capabilities, configuration, and integrations.
- [Workflows](https://agent.minimax.io/docs/cli/workflows.md): Use MiniMax Code CLI for repository work, multi-turn tasks, plans, permissions, and session recovery.
- [Configuration and models](https://agent.minimax.io/docs/cli/configuration.md): Configure MiniMax Code CLI data directories, credentials, providers, models, proxies, skills, MCP, and plugins.
- [Headless and CI](https://agent.minimax.io/docs/cli/automation.md): Use mcode exec from Shell, CI, batch jobs, and evaluations with structured output and stable exit codes.
- [TypeScript SDK](https://agent.minimax.io/docs/cli/sdk.md): Drive local MiniMax Code from Node.js with @minimax-ai/code-sdk.
- [Python SDK](https://agent.minimax.io/docs/cli/sdk-python.md): Drive local MiniMax Code from Python with minimax-code-sdk.
- [ACP integration](https://agent.minimax.io/docs/cli/integrations.md): Connect MiniMax Code CLI to editors and Agent hosts that support Agent Client Protocol.
- [Computer Use](https://agent.minimax.io/docs/cli/computer-use.md): Let MiniMax Code operate apps on your macOS or Windows computer from the interactive TUI.
- [Command reference](https://agent.minimax.io/docs/cli/reference.md): Review MiniMax Code CLI top-level commands, options, and machine-readable output entry points.
- [Security and permissions](https://agent.minimax.io/docs/cli/security.md): Understand MiniMax Code CLI permission modes, credential protection, and automation boundaries.
- [Troubleshooting](https://agent.minimax.io/docs/cli/faq.md): Troubleshoot MiniMax Code CLI installation, sign-in, configuration, automation, and terminal issues.
- [What is a Mini App?](https://agent.minimax.io/docs/miniapp/overview.md)
- [Features](https://agent.minimax.io/docs/miniapp/features.md): What Mini App can do: interface and windows, devices, backend and data, working with the Agent, sessions, building and distribution, operations, and security.
- [Capabilities and progress](https://agent.minimax.io/docs/miniapp/progress.md): The status of every Mini App capability by module: released, experimental, coming soon, or planned.
- [Architecture overview](https://agent.minimax.io/docs/miniapp/learn/architecture.md): What a Mini App is made of, how its parts talk to each other, and one full call from start to finish.
- [Mini Apps and sessions](https://agent.minimax.io/docs/miniapp/sessions.md)
- [Running and updating](https://agent.minimax.io/docs/miniapp/host/lifecycle.md): How the host discovers, starts, updates, and cleans up a Mini App. You don't need this page to build one; come back when you hit an edge case.
- [Security model](https://agent.minimax.io/docs/miniapp/host/security.md): What a Mini App can access, and how the host restricts ports, credentials, and the Agent API.
- [Build a Mini App with the Agent](https://agent.minimax.io/docs/miniapp/authors/quickstart.md): Use /miniapp-creator in the MiniMax Code desktop app to go from a one-sentence request to a working page.
- [Package structure and manifests](https://agent.minimax.io/docs/miniapp/authors/package.md): A Mini App is a regular MiniMax Plugin with a miniapp.json declaration and two runtime payloads, one for the page and one for Node.
- [Node runtime](https://agent.minimax.io/docs/miniapp/authors/node-runtime.md): The entry module exports start(context). The host launches the process, assigns the port, guards access, and cleans up.
- [Page Client API](https://agent.minimax.io/docs/miniapp/authors/client-api.md): The host injects window.mcode into the Mini App's main page through preload. Check that a method exists before calling it.
- [Two-way collaboration with the Agent](https://agent.minimax.io/docs/miniapp/authors/agent.md): The Agent can call a Mini App's tools, and a Mini App can hand work to the Agent. A person confirms at every key point.
- [Data and services](https://agent.minimax.io/docs/miniapp/authors/data.md): All business reads and writes live in the Mini App's Node service; the page only calls business APIs that Node provides.
- [Publish, debug, and troubleshoot](https://agent.minimax.io/docs/miniapp/authors/publish.md): Publishing is a transaction that can roll back. When something fails, start from the structured result the host returns.
- [Submit and share](https://agent.minimax.io/docs/miniapp/authors/share.md): Enterprise developers submit to the plugin marketplace through the official partnership process; individual developers share through the open-source community.
- [Client API reference](https://agent.minimax.io/docs/miniapp/reference/client-api.md): Page-side window.mcode.miniapp signatures, parameters, return values, permissions, and lifetimes.
- [Node API reference](https://agent.minimax.io/docs/miniapp/reference/node-api.md): Signatures, parameters, and return types for start(context), lifecycle, logging, Host Connector, and unified tool access.
- [Agent API reference](https://agent.minimax.io/docs/miniapp/reference/agent-api.md): Complete signatures, data types, events, permissions, and cancellation for Mini App Agent calls from the page and Node.
- [miniapp.json fields](https://agent.minimax.io/docs/miniapp/reference/manifest.md): Every field of the Mini App declaration. Unknown fields are rejected.
- [Error reference](https://agent.minimax.io/docs/miniapp/reference/errors.md): Error shapes, codes, and recovery for Mini App page, Node, Agent, and lifecycle APIs.
- [Changelog](https://agent.minimax.io/docs/changelog.md): Track every update to MiniMax Code.
- [Research](https://agent.minimax.io/docs/techblog.md): Research and engineering work from the MiniMax Code team.
- [Skills](https://agent.minimax.io/docs/code/agents/skills.md)
- [Common Issues](https://agent.minimax.io/docs/question.md): Solutions for common MiniMax Code client startup, login, unresponsive app, and log upload issues.
- [Product Diary: Building Professional-Grade Mini Apps on Agent OS](https://agent.minimax.io/docs/techblog/agent-as-os.md): From chatbots and workflows to agents, and now Mini Apps: why we chose to build the agent into the computer as a system service.
- [From Personal Agent to Agent Team: Designing and Open-Sourcing the BYOB Collaboration Protocol](https://agent.minimax.io/docs/techblog/byob-agent-table.md): On a trusting team, everyone works through their own bot, and people end up relaying between bots. We put everyone's bots at one table: a shared ledger, seats, the floor and a commit gateway, with no bot hosted by the table. The protocol and a reference implementation are open source.
- [Building a Testbed for Coding Agents](https://agent.minimax.io/docs/techblog/coding-agent-eval.md): Starting from MiniMax Code, building an evaluation system that can tell whether a Harness change actually helps.
- [I stopped babysitting my coding agents. Here's the workflow.](https://agent.minimax.io/docs/techblog/coding-agent-workflow-and-skills.md): What an audit of my multi-agent setup changed, and how I now define, verify and deliver work with core-grill, core-spec and deliver.
- [MCode Engineering Notes 01 | More Subagents Isn't Better: Manage Context First, Then Parallelize](https://agent.minimax.io/docs/techblog/mcode-notes-01-subagent.md): Subagents are for managing context, not for carving up territory: when to split, when not to, and how to fold them back in once you've split too much.
- [MCode Engineering Notes 02 | Too Many Tools Will Eat Your Context: From Tool Search to PTC](https://agent.minimax.io/docs/techblog/mcode-notes-02-tool-search-ptc.md): In the order we actually took in MiniMax Code: cut first, then add tool search, and finally move to PTC (letting the model write programs that call tools).
- [MCode Engineering Notes 03 | Why Long Sessions Make Agents Dumber: Compaction vs. Memory](https://agent.minimax.io/docs/techblog/mcode-notes-03-compaction-memory.md): What to do as sessions get longer: what compaction and memory are each responsible for, where each one breaks, and how they fit together.
- [MCode Engineering Notes 04 | How Long Should an Agent Wait on a Bash Command? From Foreground Blocking to Background Tasks](https://agent.minimax.io/docs/techblog/mcode-notes-04-bash-background.md): When an agent runs a bash command, should it wait for it to finish? Following that question from foreground blocking all the way to background tasks, plus the notifications, anti-polling, cleanup, and post-compaction reminders that come with them.
- [MCode Engineering Notes 05 | How Does the Agent Know the Current Time?](https://agent.minimax.io/docs/techblog/mcode-notes-05-prefix-cache.md): The model has no clock. The most direct fix is to inject the time into the system prompt — but a time that changes every turn can trash the prefix cache. From the intuition through why the prefix matters to how MCode does it.
- [MiniMax Code Is Open Source: Inside the Harness Behind a Coding Agent](https://agent.minimax.io/docs/techblog/minimax-code-harness.md): Following one task through MiniMax Code: how each turn's capabilities are assembled, how context is managed, how tools are executed, how history is committed, and how sub-agent results are confirmed.
- [Introducing MiniMax Code Mini App](https://agent.minimax.io/docs/techblog/minimax-code-mini-app.md): A Mini App is a long-running application with a frontend and a backend. It installs as a plugin, calls and is called by the Agent, and keeps the Agent's work on a page that stays live.
- [Why You Should Be in AI, and How to Do It](https://agent.minimax.io/docs/techblog/why-be-in-ai.md): Agents made experiments almost free. Now the scarce skill is asking the right question and designing the right control. Curiosity, execution and scientific literacy, and why they stack.

## AsyncAPI Specs

- [asyncapi](/docs/api-reference/speech/t2a/api/asyncapi.json)