MCP and API Help
MCP and the API are optional creator tools for workflows outside the in-game editor. Use them when you need a connected tool to work with Portals data or when you have a repeatable process that is difficult to do by hand.
They are not needed to place items, make no-code interactions, or publish a normal game.
Choose the right starting point
| You want to | Start with |
|---|---|
| Connect a supported assistant or tool to Portals | MCP setup |
| Understand the available programmatic room and asset workflows | MCP & API |
| Build gameplay inside a Portals game | Interactive Studio |
| Add a custom interface inside a game | Code & Custom UI |
Start with MCP setup
The canonical setup guide is portals.to/mcp/setup. Follow it exactly for your supported client. It contains the current connection instructions, so it is safer than copying an old configuration from a chat message or screenshot.
Use a small, safe first workflow
Before you connect an external workflow to a large game:
- Use a test project that you can recognize easily.
- Read the tool’s proposed action before you approve it.
- Check the resulting game or content in Portals.
- Keep a record of the source data and the change you made.
Do not share private connection details in public documentation, issue reports, or screenshots. If something goes wrong, remove sensitive details before asking for help.
When to use the API instead
The API reference is useful when you are building your own integration or service. Use its documented request and response formats exactly, validate input before changing real content, and test against a disposable project first.
For normal game logic, start with no-code tasks and effects. It is usually faster to build, understand, and hand off to another creator.