get_room_data

Download all room data to a temporary JSON file and return the file path. Use the file path to read the data. JSON structure: { roomItems, settings, roomTasks, quests, logic }. The logic object contains extraData keyed by item ID, stripped from roomItems.

Server Portals portals-mcp
Category Read
Risk class Low
Parameters 10 required

What get_room_data does on Portals

AI agents call get_room_data to retrieve information from Portals without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

ParameterTypeRequiredDescription
roomId string Room ID. Falls back to PORTALS_ROOM_ID env variable if omitted.

Parameters from the server's own tool schema.

Why get_room_data needs a policy

This tool retrieves and returns room data (roomItems, settings, roomTasks, quests, logic) without any capability to modify, delete, or execute actions. It is purely a query/fetch operation that reads existing data and makes it available for inspection. No side effects or destructive operations are possible.

From the tool's definition Tool name 'get_room_data' and description 'Download all room data to a temporary JSON file and return the file path. Use the file path to read the data.' indicates data retrieval with no modification or deletion.

Questions about get_room_data

What does the get_room_data tool do? +

Download all room data to a temporary JSON file and return the file path. Use the file path to read the data. JSON structure: { roomItems, settings, roomTasks, quests, logic }. The logic object contains extraData keyed by item ID, stripped from roomItems. It is categorised as a Read tool in the Portals MCP Server, which means it retrieves data without modifying state.

What parameters does get_room_data accept? +

get_room_data accepts 1 parameter: roomId. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_room_data? +

Register the Portals MCP server in PolicyLayer and add a rule for get_room_data: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Portals. Nothing to install.

What risk level is get_room_data? +

get_room_data is a Read tool with low risk. Read-only tools are generally safe to allow by default.

Can I rate-limit get_room_data? +

Yes. Add a rate_limit block to the get_room_data rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block get_room_data completely? +

Set action: deny in the PolicyLayer policy for get_room_data. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides get_room_data? +

get_room_data is provided by the Portals MCP server (portals-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// LOOK UP ANOTHER SERVER

Every MCP server has a record like this.

Type a name, get the same breakdown: verified identity, auth posture, risk grade, capabilities, recommended policy.

Teams ship this data inside their own products. See what a licence covers →

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.