Skip to main content
Glama

provider_query_preferences_vcf

Read-onlyIdempotent

Query preferences for the logged-in user with paging, sorting, and FIQL filtering to retrieve relevant settings from VCF Automation.

Instructions

Query user preferences for the logged in user. Query user preferences for the logged in user with sorting, paging, and filtering support. GET /cloudapi/v1/preferences

Input Schema

NameRequiredDescriptionDefault
pageYesPage to fetch, zero offset.
filterNoFilter for a query. FIQL format.
sortAscNoField to use for ascending sort
pageSizeYesResults per page to fetch.
sortDescNoField to use for descending sort

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is fully covered structurally. The description adds the underlying REST semantics (GET /cloudapi/v1/preferences) and confirms this is a paged read surface, but says nothing about result shape, default page size behavior, or what happens with malformed FIQL filters.

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

Conciseness3/5

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

The description is short, but the first two sentences are redundant restatements of the same action, wasting roughly half of the available text. The endpoint line at the end is useful but the redundancy shows weak front-loading and editing.

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

Completeness3/5

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

With no output schema, the agent gets no information about what a preference record looks like, and the description never clarifies the distinction between 'logged in user' preferences and org/user preferences exposed by siblings. Annotations carry the safety profile and the schema carries the parameters, so it is functional but leaves real gaps.

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%, so page, pageSize, filter (FIQL), sortAsc and sortDesc are already documented in the schema. The description's mention of 'sorting, paging, and filtering support' only paraphrases those parameters without adding format or constraint detail, so baseline 3 applies.

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

Purpose3/5

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

The description states the resource (user preferences) and scope (logged-in user) plus the HTTP endpoint, but the opening two sentences are near-duplicates, so half the text restates the same fact. It does not distinguish this from close siblings like provider_query_user_preferences, provider_get_user_preference, or provider_get_preference, so an agent cannot tell which one to pick from the description alone.

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?

There is no guidance on when to use this versus the several sibling preference-getter and preference-updater tools. The only implied usage signal is the presence of paging/sorting/filtering parameters, which the schema already conveys.

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