swsd-mcp

swsd_describe_custom_fields

Read-onlyIdempotent

List a SWSD tenant's custom-field schema, including types, required status, scope, module, and dropdown values; filter by scope, module, or active status.

Instructions

List the SWSD tenant's custom-field schema. Returns id, name, type (e.g. "Text", "Dropdown", "Date"), required, scope, module, allowed values for dropdown fields, and help_text. Useful for understanding tenant configuration and documenting integrations. Default returns active fields only — pass active_only: false to see retired ones too. Filter by scope or module to narrow the surface (the tenant may have 100+ fields). v2 NOTE: custom field WRITES are now supported via the custom_fields parameter on swsd_create_incident, swsd_update_incident, swsd_create_solution, and swsd_update_solution. Pass custom_fields: [{name, value}] (name-keyed for portability). Validated field types: Text, Dropdown, Number, Checkbox, Date. Multi_picklist and User-type writes are not yet supported — set those via the SWSD UI.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No	Page number (1-indexed).
`scope`	No	Filter to fields with this scope (e.g. "Global", "Service_Catalog", "Incident"). Tenant-specific.
`module`	No	Filter to fields scoped to this module (when set on the field).
`per_page`	No	Results per page (1-100).
`active_only`	No	If true (default), only return active fields. Set false to include retired/inactive fields too.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`pagination`	Yes
`custom_fields`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv3.0.0Oct 4, 2026

changedInput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

changedOutput schema / $schema

Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"

Changed2 schema fields changedv2.3.1Aug 22, 2026
- addedInput schema / properties / module / maxLength
```
Added value: +500
```
- addedInput schema / properties / scope / maxLength
```
Added value: +500
```
First observedv2.1.0May 28, 2026

TDQS

A4.4/5.0

Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description adds substantial context: returned field attributes, the default active-only behavior, the 100+ field scale, and v2 write support/limitations, going beyond structured annotations.

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?

The core listing purpose and return shape are front-loaded in the first two sentences, followed by parameter guidance. The v2 NOTE is long and tangential to invoking this read-only listing tool, though it provides useful cross-tool context, so it slightly dilutes conciseness.

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 annotations covering safety, a complete input schema, and an output schema, the description needs only to orient the agent. It does that and more: it explains the returned schema, default filtering, and write limitations, leaving no material gap for invoking or interpreting the listing.

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 all five parameters are already documented. The description reinforces active_only and scope/module filtering and gives a reason (tenant may have 100+ fields), but it adds no new syntactic or format details beyond the schema.

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?

The first sentence states a specific verb ("List") and resource ("SWSD tenant's custom-field schema"), and the returned fields are enumerated. It is clearly distinguishable from sibling tools like swsd_list_incidents or swsd_get_incident because it targets tenant field configuration, not ticket data.

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

Usage Guidelines4/5

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

The description gives a concrete motivation ("understanding tenant configuration and documenting integrations") and operational guidance for active_only and scope/module filtering. It does not name a when-not condition or direct alternative for listing fields, though the v2 note routes write needs to other tools.

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

Deploy Server