Check Portal Host
check_portal_hostAuthenticated tool for refreshing hostname, certificate, and OIDC readiness for a stable portal host.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| portalHostId | Yes |
check_portal_hostAuthenticated tool for refreshing hostname, certificate, and OIDC readiness for a stable portal host.
| Name | Required | Description | Default |
|---|---|---|---|
| portalHostId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate the tool is not read-only (readOnlyHint=false), not destructive (destructiveHint=false), and not idempotent. The description adds 'Authenticated tool' which is redundant since annotations imply auth. It does not disclose side effects such as potential downtime, rate limits, or what happens to existing connections. For a tool that 'refreshes' settings, this is a significant gap.
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 sentence of 12 words, which is very concise. However, it sacrifices clarity and completeness; it does not explain what 'refresh' entails or what the return value is. While brevity is valued, the description is too sparse to be fully useful.
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?
Given the tool's simplicity (one parameter, no output schema), the description should at least mention the parameter's role and the tool's effect. It lacks details on return values, error conditions, or prerequisites. The description is incomplete for an agent to reliably use the tool without additional context.
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% (no parameter descriptions in schema). The description does not mention the only parameter 'portalHostId' or explain its purpose (e.g., the ID of the portal host to refresh). Without any description of the parameter, the agent has no semantic understanding beyond its type and required status.
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 states the tool is for 'refreshing hostname, certificate, and OIDC readiness' for a portal host, which is a clear verb-resource pair. It distinguishes from sibling tools like 'create_portal_host' and 'list_portal_hosts' by indicating an update/refresh action rather than creation or listing. However, the term 'check' in the name is slightly inconsistent with 'refreshing', causing minor ambiguity.
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?
No explicit guidance on when to use this tool vs alternatives (e.g., other portal-related tools). The description implies it is for refreshing readiness but does not state prerequisites, when not to use it, or how it differs from similar tools like 'get_portal_settings' or 'create_portal_session'. The agent must infer usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.