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 already declare readOnlyHint=false, idempotentHint=false, and openWorldHint=true, so the agent knows this has side effects and touches external state. The description adds useful context beyond that: it is authenticated, and the refresh targets hostname, certificate, and OIDC readiness specifically. It does not disclose what the refresh changes or any return/error behavior, so it adds moderate value only.
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?
A single well-formed sentence with the operation and target front-loaded and no filler. It is appropriately sized, though the brevity comes at the cost of the missing usage and parameter detail scored elsewhere.
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 one-parameter tool with no output schema and meaningful annotations, the description covers the operation but omits selection guidance and any explanation of the required portalHostId. It is minimally viable rather than fully complete.
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 description coverage is 0% and the description never mentions the single parameter portalHostId, failing to explain what it identifies or its format. With a required parameter left undocumented in both schema and description, this gap matters more than it would for a zero-parameter tool.
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 a specific action ('refreshing hostname, certificate, and OIDC readiness') against a clear resource ('a stable portal host'), which is more than a tautology. It does not differentiate itself from siblings such as list_portal_hosts or create_portal_host, though the readiness-check verb scope is reasonably distinct.
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?
There is no when-to-use guidance, no mention of prerequisites or alternatives, and no exclusions. 'For a stable portal host' hints at a precondition but is not actionable selection criteria for an agent choosing among sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.