Get Portal Settings
get_portal_settingsAuthenticated tool for reading portal branding defaults and host setup for an app.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes |
get_portal_settingsAuthenticated tool for reading portal branding defaults and host setup for an app.
| Name | Required | Description | Default |
|---|---|---|---|
| appId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true, idempotentHint=true, and destructiveHint=false, indicating safe read behavior. The description adds 'Authenticated' but lacks additional behavioral details such as error handling or response format.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, well-structured sentence that conveys the core purpose without unnecessary words, making it concise and easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read tool with one parameter and no output schema, the description is adequate but minimal. It covers purpose but omits important context like return value details or when to use compared to siblings.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, requiring the description to explain the 'appId' parameter. The description only mentions 'for an app' generically, without specifying the parameter's meaning, format, or relationship to other tools.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'reading' and the resources 'portal branding defaults and host setup' for an app, distinguishing it from sibling tools like 'save_portal_settings' or 'check_portal_host'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description mentions 'Authenticated tool' but does not provide explicit guidance on when to use this tool versus alternatives like 'check_portal_host' or 'list_portal_hosts', nor any exclusions or prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.