Skip to main content
Glama

search_help_articles

Read-only

Find plant care guides and store policies by keyword, returning ranked article IDs, titles, and snippets; use get_help_article to read the full article.

Instructions

Search Demo Plant Shop policies and plant care guides by keyword. Returns ranked article IDs, titles and snippets. Use get_help_article to read the full article.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "search_help_articles"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
queryYes

Output Schema

NameRequiredDescriptionDefault
articlesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that results are ranked and include IDs, titles and snippets, which is a useful behavioral detail, but says nothing about match behavior, empty-result handling, or how ranking is determined.

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 short sentences, front-loaded with the purpose, then the return shape, then the follow-up action. Every sentence earns its place with no filler.

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

Completeness4/5

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

For a simple two-parameter read-only search, the description plus annotations plus the existing output schema cover nearly everything an agent needs. The only gap is the unmentioned 'limit' parameter, though its schema default and bounds are self-documenting.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry parameter meaning. It conveys that the required input is a keyword query, but the 'limit' parameter (default 5, max 10) is never mentioned, leaving half the parameters undocumented in prose.

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 Demo Plant Shop policies and plant care guides by keyword') and names the retrieval scope. It also distinguishes itself from the sibling get_help_article by framing itself as the search step and that tool as the full-read step.

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 final sentence explicitly routes the agent: use this to find articles, then 'Use get_help_article to read the full article.' That gives a clear usage context and a named alternative. It stops short of explicit when-not guidance (e.g., product lookup should go to find_plants), so it is not a full 5.

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