docs: add AI agents and external tools section to guides
Some checks failed
Deploy to Production / Build and Deploy (push) Has been cancelled
Some checks failed
Deploy to Production / Build and Deploy (push) Has been cancelled
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
91
GUIDE.en.md
91
GUIDE.en.md
@@ -338,6 +338,97 @@ AI providers can also be configured from the interface:
|
||||
|
||||
---
|
||||
|
||||
## AI Agents and External Tools
|
||||
|
||||
Memento includes a configurable AI agent system that can perform automated actions using external tools.
|
||||
|
||||
### Agent Types
|
||||
|
||||
| Type | Description | Default Tools |
|
||||
|------|-------------|---------------|
|
||||
| **Scraper** | Scrapes web pages and creates notes | `web_scrape`, `note_create` |
|
||||
| **Researcher** | In-depth web research + synthesis | `web_search`, `web_scrape`, `note_search`, `note_create` |
|
||||
| **Monitor** | Watches a notebook and analyzes notes | `note_search`, `note_read`, `note_create` |
|
||||
| **Custom** | Free-form agent with custom instructions | configurable |
|
||||
|
||||
### Available Tools
|
||||
|
||||
| Tool | External | Description | Required Config |
|
||||
|------|----------|-------------|-----------------|
|
||||
| `web_search` | Yes | Web search (SearXNG or Brave) | SearXNG URL or Brave API key |
|
||||
| `web_scrape` | Yes | Scrape a web page to Markdown (Jina Reader) | Jina key (optional) |
|
||||
| `url_fetch` | No | Fetch JSON/CSV/text content from a URL | None |
|
||||
| `note_search` | No | Keyword search in user's notes | None |
|
||||
| `note_read` | No | Read a specific note by ID | None |
|
||||
| `note_create` | No | Create a new note | None |
|
||||
| `memory_search` | No | Search past agent execution history | None |
|
||||
|
||||
### Web Search - SearXNG (recommended)
|
||||
|
||||
SearXNG is an open-source, self-hosted metasearch engine. It is the default web search provider.
|
||||
|
||||
**Install SearXNG:**
|
||||
|
||||
```bash
|
||||
# Via Docker
|
||||
docker run -d --name searxng \
|
||||
-p 8080:8080 \
|
||||
-e SEARXNG_BASE_URL=http://localhost:8080 \
|
||||
--restart unless-stopped \
|
||||
searxng/searxng:latest
|
||||
```
|
||||
|
||||
**Configure in Memento:**
|
||||
|
||||
1. Go to `/admin/settings`
|
||||
2. Section "Tools"
|
||||
3. Web Search Provider: select `SearXNG (Self-hosted)`
|
||||
4. SearXNG URL: `http://localhost:8080` (or your instance URL)
|
||||
5. Save
|
||||
|
||||
**In Docker (shared network):**
|
||||
|
||||
If SearXNG and Memento are on the same Docker network, use the service name:
|
||||
```
|
||||
http://searxng:8080
|
||||
```
|
||||
|
||||
### Web Search - Brave Search (alternative)
|
||||
|
||||
Brave Search is a paid API alternative to SearXNG.
|
||||
|
||||
1. Create an account at [brave.com/search/api](https://brave.com/search/api/)
|
||||
2. Get an API key
|
||||
3. In `/admin/settings` > Tools: select `Brave Search API` and enter the key
|
||||
|
||||
Both providers can be used simultaneously by selecting `Both`.
|
||||
|
||||
### Web Scraping - Jina Reader (optional)
|
||||
|
||||
The `web_scrape` tool uses [Jina Reader](https://jina.ai/reader/) to convert web pages to Markdown. It works without an API key (rate-limited), or with a key for higher limits.
|
||||
|
||||
1. Create an account at [jina.ai](https://jina.ai/)
|
||||
2. Get an API key
|
||||
3. In `/admin/settings` > Tools: enter the Jina key
|
||||
|
||||
### Using Agents
|
||||
|
||||
1. Go to `/agents`
|
||||
2. Click "New agent" or choose a template
|
||||
3. Configure:
|
||||
- **Name and description**
|
||||
- **Type** (Scraper, Researcher, Monitor, Custom)
|
||||
- **Instructions** (system prompt)
|
||||
- **Tools** (select active tools)
|
||||
- **Frequency** (manual, hourly, daily, weekly, monthly)
|
||||
- **Target notebook** (where to save results)
|
||||
- **Source URLs** (for scrapers)
|
||||
4. Save and run
|
||||
|
||||
Agents are also available in **AI Chat**: when web search is enabled, the chat automatically uses `web_search` and `web_scrape` tools.
|
||||
|
||||
---
|
||||
|
||||
## MCP Server
|
||||
|
||||
The MCP server (Model Context Protocol, v3.1) allows AI agents to interact with your notes via a standardized protocol.
|
||||
|
||||
Reference in New Issue
Block a user