Search Agent Knowledge

Tool ID: agent_knowledge_search

Summary

Searches your knowledge base for entries that match your words — for example FAQ questions and answers that contain "shipping", "warranty", or "return policy".

When to use it

  • Answer customer or team questions — Find official answers before the AI replies.
  • Check if something already exists — Search before adding a new FAQ to avoid duplicates.
  • Find an entry to edit — Locate the record and its id before asking for an update or delete.
  • Research internal knowledge — Look up how your organization documents common topics.

What you need

Requirement Required?
Metraclick connection Yes
Tool enabled for your account Yes
Agent Knowledge database credentials Yes

If search fails with a credentials error, ask your administrator to configure Agent Knowledge for your account.

Parameters

Parameter Required? Description
query Yes Words or phrase to search for. Multiple words can be combined as "match any" or "match all" (see match_mode).
sources No Which sources to search. Default: FAQ only (["faq"]).
limit No Maximum number of results (1–50). Default: 10.
match_mode No or (default) — match any search word; and — entry must contain all words.

Search looks inside the text fields defined for each source (for FAQ: question and answer).

What you get back

Field Meaning
row_count How many entries matched
rows List of matching records with fields such as id, question, answer, created_at, last_changed
_source Which knowledge source each row came from (e.g. faq)
query, terms, match_mode Echo of how the search was run

Results are sorted by last changed (newest first) when that field exists.

Example: A search for "return policy" might return:

{
  "row_count": 1,
  "rows": [
    {
      "id": 42,
      "question": "What is your return policy?",
      "answer": "You may return items within 30 days...",
      "last_changed": "2026-03-01 14:22:00",
      "_source": "faq"
    }
  ]
}

Example prompts

Simple lookup

Search our Agent Knowledge for anything about shipping times and summarize what you find.

Before answering a customer

A customer asked about warranty coverage. Search our FAQ knowledge base and draft a reply based on official answers only.

Find duplicates before adding

Search Agent Knowledge for "password reset" before we add a new FAQ. Tell me if something similar already exists.

Narrow results

Search our knowledge base for entries that contain both "invoice" and "VAT". I only need the top 5 results.

Prepare an edit

Find the FAQ about holiday opening hours in Agent Knowledge and show me its id so we can update it.

Tips

  • Use specific words — "refund credit card" usually works better than a single vague word like "help".
  • and vs or — Default behavior matches any word (or). Ask for "must contain all of these words" when you need stricter filtering (and).
  • Empty results — Try shorter or alternate terms, or ask for the Overview to confirm which sources are searchable.
  • Editing next — Copy the id from search results when you want to update or delete an entry.
  • Limit — You can ask for "up to 20 results" if you need a broader list (maximum 50).

Related