Skip to main content
Glama

List Credential Profiles

cnc_list_credential_profiles
Read-onlyIdempotent

Lists credential profiles known to Crosswork with optional name filter and paging so you can find profile names for devices or providers and check covered protocols like SSH, HTTP, and SNMPv2.

Instructions

List credential profiles known to Crosswork, with optional name filter and paging.

Read-only. Use it to find the profile name to reference when adding devices or providers, or to check which protocols (SSH/HTTP/HTTPS/SNMPv2/...) a profile covers. For one profile's full record use cnc_get_credential_profile.

Secrets are masked by the API ("******"); usernames are returned in clear.

Args: profile: name filter (exact, case-insensitive, '*' wildcard; surrounding whitespace is stripped and a blank filter means no filter). page_size / page: filterData paging (0-based page). response_format: 'markdown' (default) or 'json'.

Returns: str: Markdown "- profile — types: SSH (user), HTTP (user), SNMPv2" lines, or JSON: {"total": int|null, "count": int, "page": int, "page_size": int, "items": [{"profile": str, "user_pass": [{"user_name": str, "password": "", "type": "ROBOT_USERPASS_SSH|HTTP|HTTPS|..."}], "v2_info": {"read_community": "", ...}?}, ...], "has_more": bool, "next_page": int|null, "collection_total": int|null} "total" is the number of profiles matching the filter (null when the platform omits it, i.e. zero matches); "collection_total" is the size of the whole collection regardless of filter. On failure: "Error: " (500 "NATS request failed" -> the query body was rejected; 403 -> token rejected or missing privilege).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo0-based page number (e.g. 0).
profileNoFilter by profile name: exact match, case-insensitive, '*' is a wildcard (e.g. 'nso', 'cml-*', '*xrd'). No filter lists every profile.
page_sizeNoProfiles per page (e.g. 20).
response_formatNo'markdown' for human-readable output, 'json' for complete data.markdown

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations (readOnly/idempotent/openWorld), the description discloses that secrets are masked as '******' while usernames are clear, and maps failure modes (500 NATS request failed, 403 token rejected or missing privilege). That is auth/behavioral context the annotations cannot convey.

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

Conciseness4/5

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

Front-loaded with purpose and routing, then cleanly sectioned into Args and Returns. The Returns block is verbose and largely duplicates the existing output schema, which is the main place text is not fully earning its place.

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

Completeness5/5

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

For a 4-param read-only list tool, the definition covers purpose, alternatives, filters, paging, output shape, and error semantics. An agent has everything needed to call it correctly and interpret results.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% so the baseline is 3, but the description adds semantics the schema lacks: surrounding whitespace is stripped, a blank filter means no filter, and paging is explicitly 0-based with the response_format default restated. It goes modestly beyond the schema rather than merely echoing it.

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

Purpose5/5

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

First sentence states a specific verb (List) and resource (credential profiles) plus scope modifiers (name filter, paging). It explicitly contrasts itself with the sibling cnc_get_credential_profile, so the agent can route without inspecting either schema.

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

Usage Guidelines5/5

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

Gives concrete when-to-use reasons ('find the profile name to reference when adding devices or providers', 'check which protocols a profile covers') and names the alternative for the single-record case. Nothing is left to inference.

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