Skip to main content
Glama

Get Supplier Portal Settings

sirv_get_supplier_portal_settings
Read-onlyIdempotent

Read a workspace's Supplier Portal SFTP connection details and image requirements, including pass threshold and autofix status, to guide supplier setup or check rules before autofix.

Instructions

Read the workspace's Supplier Portal settings in one call:

  • sftp: the supplier SFTP connection, with host, port, username and root path.

  • requirements: the rules that supplier images must meet, the pass threshold, and whether autofix is on.

Use it to tell a supplier how to connect, or to read the rules before sirv_run_supplier_autofix. Do not use it to change a setting or reset the SFTP password: do that in Studio.

Input: only the optional orgId; without it, the tool reads the workspace you signed in to.

The SFTP part needs Supplier Portal Pro SFTP. Without it, that part says it is not available, and the requirements still return. Read-only.

Credits: free.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sirv_get_supplier_portal_settings"
  }
}

Input Schema

NameRequiredDescriptionDefault
orgIdNoWorkspace id from sirv_list_organizations. Default: the workspace you signed in to

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.1

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds real behavior beyond them: the SFTP section requires Supplier Portal Pro and degrades to 'not available' while requirements still return, plus a free-credit note. This partial-result behavior is the kind of detail 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.

Conciseness5/5

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

Front-loaded verb statement, then a compact bullet list of returned sections, then usage, input, gating, and credit notes in short sentences. Every line carries distinct information with no padding.

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?

With no output schema, the description compensates by naming the fields each section returns, and it discloses tier gating and partial-failure behavior. An agent could call this correctly and interpret a degraded response without further information.

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 the orgId parameter already documents the default workspace, so the description's 'only the optional orgId; without it, the tool reads the workspace you signed in to' largely restates the schema. It confirms the single-parameter surface but adds no format or sourcing detail beyond what is already structured.

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?

States a specific verb and resource ('Read the workspace's Supplier Portal settings') and then enumerates the two returned sections (sftp, requirements), so an agent knows exactly what this yields. It is clearly distinguishable from mutating siblings like sirv_run_supplier_autofix.

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 explicit when-to-use cases ('tell a supplier how to connect', 'read the rules before sirv_run_supplier_autofix') and an explicit when-not with the alternative dismissed ('Do not use it to change a setting or reset the SFTP password: do that in Studio').

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