Skip to main content
Glama

Search articles

search_articles
Read-only

Search knowledge base articles by keyword.

Returns matching articles and a url_schema template (e.g. 'https://.../:locale/articles/:slug'). To link to an article, replace :slug and :locale in the schema with the article's fields.

To simply list articles without a query, use list_articles instead.

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_articles"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default: 1).
queryYesThe search query string.
per_pageNoNumber of results per page (default: 30, max: 100).

Output Schema

NameRequiredDescriptionDefault
pageNo
articlesNo
has_moreNo
per_pageNo
url_schemaNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint=false and destructiveHint=false, so safety is covered structurally. The description adds real value beyond that by explaining the returned url_schema template and the `:slug`/`:locale` substitution needed to build links, which is non-obvious behavior.

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-loads purpose in one short sentence, then the return-format note, then the alternative. Every sentence is functional, though the url_schema explanation is somewhat verbose for a paragraph about formatting.

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?

An output schema exists, so return values need not be described, and the description still adds the link-construction detail that schemas rarely convey. For a simple three-param search tool this is essentially complete, with only ranking or query-syntax behavior left implicit.

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% for all three parameters (page, query, per_page defaults and bounds), so the schema carries the semantics. The description adds nothing about query syntax, matching behavior, or pagination beyond 'keyword', so baseline 3 applies.

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+resource combination ('Search knowledge base articles by keyword') and immediately names the sibling it is not (list_articles), so an agent can distinguish it without opening the schema.

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?

Explicitly routes the no-query case to list_articles, which is a clear when-not rule. It does not address when to use get_article for a known item, so guidance is good but not exhaustive.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.