Skip to main content
Glama

Search the internal wiki

wiki_search
Read-onlyIdempotent

Search HR, IT, finance, and engineering wiki pages by keyword to retrieve titles, matching snippets, and links to full pages.

Instructions

Keyword search over HR, IT, finance and engineering wiki pages. Returns titles, a matching snippet and a wiki:// resource link for the full page. Requires role: viewer.

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": "wiki_search"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMax items per page (default 3, max 10)
queryYes

Output Schema

NameRequiredDescriptionDefault
resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety and repeatability are covered. The description adds two things annotations cannot express: the shape of the result (titles, a matching snippet, a wiki:// resource link) and an authorization prerequisite ("Requires role: viewer"), which prevents a permission failure at call time.

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 with zero padding: what it searches, what it returns, what it requires. The most decision-relevant facts are front-loaded and no sentence duplicates the schema or annotations.

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?

With an output schema present, return values needn't be explained, so mentioning them is a small redundancy rather than a gap. The omission of any pointer to wiki_get_page for retrieving the full page is the main shortfall, given the description itself says the result is only a snippet plus a link. Otherwise it is complete enough for a two-parameter read tool.

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 50%: limit is documented in the schema, but query only carries length bounds (2-200) with no description. The word "Keyword" adds real meaning by signalling term-based matching rather than natural-language search, but it says nothing about multi-term behavior, matching scope, or empty-result handling, so it only partially compensates.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Keyword search over ... wiki pages") and scopes the corpus to HR, IT, finance and engineering, which separates it from a page-fetch tool like wiki_get_page. It stops short of naming any sibling explicitly, so the differentiation is inferable rather than stated.

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

Usage Guidelines3/5

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

Usage is implied by the phrase "keyword search" and the enumerated content domains, which tell an agent roughly when this is the right tool. However, there is no explicit when-to-use/when-not guidance and no reference to wiki_get_page as the follow-up (or alternative) tool, which matters since the return is only a snippet plus a wiki:// link.

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