bump version
This commit is contained in:
Caren Thomas
@@ -1,150 +0,0 @@
|
||||
---
|
||||
title: Base Tools
|
||||
subtitle: Built-in tools for memory management and user communication
|
||||
slug: guides/agents/base-tools
|
||||
---
|
||||
|
||||
Base tools are built-in tools that enable memory management, user communication, and access to conversation history and archival storage.
|
||||
|
||||
## Available Base Tools
|
||||
|
||||
| Tool | Purpose |
|
||||
|------|---------|
|
||||
| `memory_insert` | Insert text into a memory block |
|
||||
| `memory_replace` | Replace specific text in a memory block |
|
||||
| `memory_rethink` | Completely rewrite a memory block |
|
||||
| `memory_finish_edits` | Signal completion of memory editing |
|
||||
| `conversation_search` | Search prior conversation history |
|
||||
| `archival_memory_insert` | Add content to archival memory |
|
||||
| `archival_memory_search` | Search archival memory |
|
||||
| `send_message` | Send a message to the user (legacy architectures only) |
|
||||
|
||||
## Memory Block Editing
|
||||
|
||||
Memory blocks are editable sections in the agent's context window. These tools let agents update their own memory.
|
||||
|
||||
See the [Memory Blocks guide](/guides/agents/memory-blocks) for more about how memory blocks work.
|
||||
|
||||
### memory_insert
|
||||
|
||||
Insert text at a specific line in a memory block.
|
||||
|
||||
**Parameters:**
|
||||
- `label`: Which memory block to edit
|
||||
- `new_string`: Text to insert
|
||||
- `insert_line`: Line number (0 for beginning, -1 for end)
|
||||
|
||||
**Common uses:**
|
||||
- Add new information to the end of a block
|
||||
- Insert context at the beginning
|
||||
- Add items to a list
|
||||
|
||||
### memory_replace
|
||||
|
||||
Replace specific text in a memory block.
|
||||
|
||||
**Parameters:**
|
||||
- `label`: Which memory block to edit
|
||||
- `old_string`: Exact text to find and replace
|
||||
- `new_string`: Replacement text
|
||||
|
||||
**Common uses:**
|
||||
- Update outdated information
|
||||
- Fix typos or errors
|
||||
- Delete text (by replacing with empty string)
|
||||
|
||||
**Important:** The `old_string` must match exactly, including whitespace. If it appears multiple times, the tool will error.
|
||||
|
||||
### memory_rethink
|
||||
|
||||
Completely rewrite a memory block's contents.
|
||||
|
||||
**Parameters:**
|
||||
- `label`: Which memory block to rewrite
|
||||
- `new_memory`: Complete new contents
|
||||
|
||||
**When to use:**
|
||||
- Condensing cluttered information
|
||||
- Major reorganization
|
||||
- Combining multiple pieces of information
|
||||
|
||||
**When not to use:**
|
||||
- Adding one line (use `memory_insert`)
|
||||
- Changing specific text (use `memory_replace`)
|
||||
|
||||
### memory_finish_edits
|
||||
|
||||
Signals that memory editing is complete.
|
||||
|
||||
**Parameters:** None
|
||||
|
||||
Some agent architectures use this to mark the end of a memory update cycle.
|
||||
|
||||
## Recall Memory
|
||||
|
||||
### conversation_search
|
||||
|
||||
Search prior conversation history using both text matching and semantic similarity.
|
||||
|
||||
**Parameters:**
|
||||
- `query`: What to search for
|
||||
- `roles`: Optional filter by message role (user, assistant, tool)
|
||||
- `limit`: Maximum number of results
|
||||
- `start_date`, `end_date`: ISO 8601 date/datetime filters (inclusive)
|
||||
|
||||
**Returns:**
|
||||
Matching messages with role and content, ordered by relevance.
|
||||
|
||||
**Example queries:**
|
||||
- "What did the user say about deployment?"
|
||||
- "Find previous responses about error handling"
|
||||
- "Search tool outputs from last week"
|
||||
|
||||
## Archival Memory
|
||||
|
||||
Archival memory stores information long-term outside the context window. See the [Archival Memory documentation](/guides/agents/archival-memory) for details.
|
||||
|
||||
### archival_memory_insert
|
||||
|
||||
Add content to archival memory for long-term storage.
|
||||
|
||||
**Parameters:**
|
||||
- `content`: Text to store
|
||||
- `tags`: Optional tags for organization
|
||||
|
||||
**Common uses:**
|
||||
- Storing reference information for later
|
||||
- Saving important context that doesn't fit in memory blocks
|
||||
- Building a knowledge base over time
|
||||
|
||||
### archival_memory_search
|
||||
|
||||
Search archival memory using semantic (embedding-based) search.
|
||||
|
||||
**Parameters:**
|
||||
- `query`: What to search for semantically
|
||||
- `tags`: Optional tag filters
|
||||
- `tag_match_mode`: "any" or "all" for tag matching
|
||||
- `top_k`: Maximum results
|
||||
- `start_datetime`, `end_datetime`: ISO 8601 filters (inclusive)
|
||||
|
||||
**Returns:**
|
||||
Matching passages with timestamps and content, ordered by semantic similarity.
|
||||
|
||||
## Deprecated Tools
|
||||
|
||||
These tools are still available but deprecated:
|
||||
|
||||
| Tool | Use Instead |
|
||||
|------|-------------|
|
||||
| `send_message` | Agent responses (no tool needed). See [legacy architectures](/guides/legacy/memgpt_agents_legacy) |
|
||||
| `core_memory_append` | `memory_insert` with `insert_line=-1` |
|
||||
| `core_memory_replace` | `memory_replace` |
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Memory Blocks](/guides/agents/memory-blocks)
|
||||
- [Archival Memory](/guides/agents/archival-memory)
|
||||
- [Utilities](/guides/agents/prebuilt-tools)
|
||||
- [Multi-Agent Tools](/guides/agents/multi-agent)
|
||||
- [Custom Tools](/guides/agents/custom-tools)
|
||||
Reference in New Issue
Block a user