Skip to main content
Glama
mikimatsub

swsd-mcp

by mikimatsub
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

swsd_search_solutions

Read-onlyIdempotent

Search SWSD knowledge-base solution articles by free-text query or category filter, returning compact summaries with excerpts. Use it to find relevant solutions before fetching full article bodies.

Instructions

Search SWSD knowledge-base solution articles. Pass query for free-text search across titles and descriptions; pass category to filter to a category name. Returns compact summaries with truncated excerpts (240 chars). Use swsd_get_solution for the full HTML body of any one result. NOTE: search is asynchronously indexed — articles created or updated in the last few minutes (sometimes hours) may not appear yet. To verify a just-created article, use swsd_get_solution with the ID returned by swsd_create_solution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (1-indexed).
queryNoFree-text search across solution titles and descriptions. Empirically the canonical search parameter for SWSD solutions (verified against tenant 2026-05-03).
categoryNoFilter to solutions in this category name. Use swsd_list_categories to validate names.
per_pageNoResults per page (1-100).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
solutionsYes
paginationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv3.0.0
    • 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"
  2. Changed2 schema fields changedv2.3.1
    • addedInput schema / properties / category / maxLength
      Added value: +500
    • addedInput schema / properties / query / maxLength
      Added value: +2000
  3. First observedv2.1.0

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, and the description adds genuinely new behavioral context: results are compact summaries with 240-char truncated excerpts, and the index is asynchronous with a freshness lag. The indexing caveat is a non-obvious trait that would otherwise cause an agent to wrongly conclude an article was never created.

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?

Three tight sentences, front-loaded with the core action, then details, then the alternative and the caveat. Each sentence earns its place with no redundancy.

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?

An output schema exists, so return-value explanation is optional, yet the description still notes the truncated-excerpt format. Combined with the freshness caveat and the routing to swsd_get_solution, nothing an agent needs to call this correctly is missing.

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 the schema already documents all four parameters. The description restates the semantics of query and category, adding little beyond what the schema provides, and says nothing about the page/per_page pagination parameters. Baseline 3 applies when the schema does the heavy lifting.

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 ('Search SWSD knowledge-base solution articles') and immediately distinguishes itself from the sibling swsd_get_solution, which returns full bodies. An agent can tell exactly what this tool does and where it sits relative to its neighbors without opening a 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?

Explicitly covers the two usage modes (query for free-text, category for filtering), names the alternative tool for retrieving full bodies, and warns about the async indexing delay with a concrete workaround for verifying just-created articles. When-to-use, when-not (won't see fresh articles), and alternatives are all present.

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