Nopaque TotalPath

Get Plan and Allowances

getWorkspacePlan

Read-onlyIdempotent

The workspace's plan and tier, when the billing period starts and renews, purchased credit left (total in cents, currency, and display as the amount to quote, or null), a custom deal's summary (state, dates, and quota granted, used and remaining each with display; or null), and each free allowance with what is used. Quote an amount by its display text exactly as returned; never add or convert amounts. Use when: someone asks what plan they are on, what it includes, when it renews or how much credit is left. Owner or billing admin only; other roles get 403. Only a person signed in to the nopaque web app can call this; an API key is refused.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspaceId": "<workspaceId>"
    },
    "name": "getWorkspacePlan"
  }
}

Input Schema

Name	Required	Description	Default
`workspaceId`	Yes	Workspace identifier. Must be the caller's current workspace.

Output Schema

Name	Required	Description
`deal`	Yes	A custom deal's summary, or null when there is no deal. Quota amounts are minor units of `currency`; quote their `display`. Per-minute rates are not included.
`plan`	Yes	The plan the workspace is on (auth's effectiveTier).
`tier`	Yes	The stored subscription tier.
`credit`	Yes	Purchased credit left, as the Billing page shows it, or null when the workspace has no billing account yet. Quote `display`.
`freePools`	Yes	The Free tier's monthly free allowances. Empty on any other plan, where they are not counted down.
`periodEnd`	No
`balanceLeft`	Yes	What is left to draw usage from, one line per name as the Billing page lists it: a plan's licence, a free allocation, a pack. Drained lines are left out. Quote `display`.
`periodStart`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 11, 2026

TDQS

A4.4/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly/idempotent/non-destructive/closed-world, and the description adds meaningful behavior beyond them: role-based authorization with a 403 outcome, rejection of API-key callers, null semantics for absent credit or deal data, and the display-formatting rule for quoting amounts. These are exactly the operational constraints an agent needs before calling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the resource and its returned fields, followed by usage triggers and access constraints, with no filler sentences. The long parenthetical enumeration of return fields is dense but each clause carries information; slightly heavier nesting keeps it from a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, yet the description still flags the ambiguities that matter (nullable credit and deal blocks, the `display` quoting convention). Combined with the authorization and session requirements, an agent has everything needed to decide and call correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the single workspaceId parameter is already documented in the schema as the caller's current workspace, so the baseline of 3 applies. The description implies a workspace scope but adds no new detail about the identifier itself.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific resource and enumerates its contents precisely: plan and tier, billing period start/renewal, purchased credit remaining, custom deal summary, and free allowances. This is far more specific than a sibling like getWorkspaceUsage and lets an agent distinguish it without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

An explicit 'Use when' clause covers the main intents (which plan, what it includes, renewal date, credit left). It adds hard access conditions (owner or billing admin only, 403 otherwise) and the session-only rule. It stops short of naming alternative tools or stating when not to use it, so it falls just short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Nopaque TotalPath tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.