list_widgets
Beta. Read precomputed current-month cloud spend and forecast metrics. Widget results are refreshed in the background; reading a widget returns the latest cached result and never starts a synchronous refresh. Use the list operation to discover the complete catalogue. Returns the complete catalogu...
This record as markdown: /tools/doit/list-widgets.md
What list_widgets does on Doit
AI agents call list_widgets to retrieve information from Doit without modifying anything. It is typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
X-Tenant-Id | string | — | |
customerContext | string | — | Scope the request to a specific customer by ID. Required for DoiT employees (whose token isn't tied to a single customer); omit for direct customer users. |
Parameters from the server's own tool schema.
Why list_widgets is rated Low
Even though list_widgets only reads data, uncontrolled read access leaks sensitive information and racks up API costs: an agent caught in a retry loop can make thousands of calls a minute without anyone noticing.
Attacks that exploit this kind of access
The rule that runs list_widgets safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Doit, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For list_widgets, this is the rule to start with:
list_widgets is read-only, so it stays allowed. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Doit, apply this rule, and every list_widgets call is checked against it from then on.
Questions about list_widgets
Beta. Read precomputed current-month cloud spend and forecast metrics. Widget results are refreshed in the background; reading a widget returns the latest cached result and never starts a synchronous refresh. Use the list operation to discover the complete catalogue. Returns the complete catalogue of preset widgets supported by the Analytics Widgets API. Each entry contains a customer-specific id and a stable customer-facing alias; either value can be passed to the get-widget operation. An id can vary by customer or service tier, while an alias remains stable. Authenticate with Authorization: Bearer <token>. Omit X-Tenant-Id when the credential resolves to one customer. When the credential can act on multiple customers, send X-Tenant-Id: <tenant-id> to select the customer. A 403 response means the caller or selected customer is not authorized or entitled to use this API. It is categorised as a Read tool in the Doit MCP Server, which means it retrieves data without modifying state.
list_widgets accepts 2 parameters: X-Tenant-Id, customerContext. The full parameter table on this page comes from the server's own tool schema.
Register the Doit MCP server in PolicyLayer and add a rule for list_widgets: 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 Doit. Nothing to install.
list_widgets is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the list_widgets 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.
Set action: deny in the PolicyLayer policy for list_widgets. 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.
list_widgets is provided by the Doit MCP server (@doitintl/doit-mcp-server). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Doit, and thousands of servers like it.
This server
Across the catalogue