Agent Knowledge Overview
Tool ID: agent_knowledge_overview
Summary
Lists the knowledge sources available to your account (such as FAQ), what each source contains, which fields can be searched, and which fields can be created or edited.
When to use it
- First time using Agent Knowledge — See what data your AI can access before searching or editing.
- Before creating or updating entries — Learn which fields are required and what they mean.
- When edit fails — If the AI reports an "unknown field" error, check the overview for the correct field names.
- Explore new sources — Your administrator may add sources beyond FAQ; this tool shows what is available.
What you need
| Requirement | Required? |
|---|---|
| Metraclick connection | Yes |
| Tool enabled for your account | Yes |
| Agent Knowledge database credentials | No |
This tool reads the catalog of sources only. It does not query your database.
Parameters
| Parameter | Required? | Description |
|---|---|---|
include |
No | List of specific source keys to show (for example ["faq"]). If omitted, all sources are listed. |
What you get back
A list of sources, each with:
| Field | Meaning |
|---|---|
source |
Short key used by search and edit (e.g. faq) |
description |
Plain-language explanation of what the source holds |
search_columns |
Fields the Search tool looks through |
writable |
Fields you can set when creating or updating entries |
editable |
Whether this source allows create/update/delete |
For the FAQ source, writable fields are typically question and answer (both required when creating a new entry).
Example prompts
See what is available
What Agent Knowledge sources do I have access to? List them with a short explanation of each.
Check editable fields before adding a FAQ
Show me the Agent Knowledge overview for FAQ — what fields do I need when adding a new question and answer?
Onboarding
I'm new to Agent Knowledge. Give me an overview of what data I can search and what I can edit.
Filter to one source
Show me only the FAQ source in Agent Knowledge and tell me which columns I can write to.
Tips
- Start here for edits — Before creating or updating entries, ask for the overview so the AI knows the correct field names.
- No database needed — This tool works even if search/edit credentials are not set up yet; use it to understand what will be available once configuration is complete.
- Next step — Use Search to find entries, or Edit to add or change them.