Skip to main content
Glama

get_portfolio

Read-only

Retrieve a portfolio by sys_id, including all linked projects, to inspect portfolio structure and project associations in ServiceNow.

Instructions

Get a portfolio (pm_portfolio) by sys_id, with the projects linked to it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sys_idYessys_id of the portfolio

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv4.16.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds one useful behavioral detail — that the response includes the linked projects — but says nothing about error behavior when the sys_id does not exist.

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

Conciseness5/5

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

One tight sentence that front-loads the operation, the resource, the table, and the key, then appends the extra return scope. Nothing wasted.

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

Completeness4/5

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

For a simple single-record read whose annotations carry the safety profile, this is nearly complete — table name and included relation are stated. Only the missing not-found behavior and the absence of explicit sibling routing keep it from a 5.

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 coverage is 100% and there is a single parameter, so the schema fully documents sys_id. The description's 'by sys_id' adds no format or syntax detail beyond what the schema already provides, so the baseline of 3 is appropriate.

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

Purpose4/5

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

States a specific verb (get), resource (portfolio), the underlying table (pm_portfolio), and the lookup key (sys_id), plus that linked projects are included. It does not explicitly distinguish itself from the sibling list_portfolios, leaving the singular-vs-list distinction to inference.

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

Usage Guidelines2/5

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

The description gives no when-to-use guidance, no prerequisites (e.g. needing a valid sys_id from list_portfolios), and never names an alternative. Usage is only implied by the phrase 'by sys_id'.

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

Deploy Server

Other Tools