docs: update all MCP documentation for 22 tools + API key auth
All checks were successful
Deploy to Production / Build and Deploy (push) Successful in 15s
All checks were successful
Deploy to Production / Build and Deploy (push) Successful in 15s
- Rewrite mcp-server/README.md: clean structure, auth section, 22 tools - Rewrite N8N-CONFIG.md: remove hardcoded IPs, add x-api-key auth flow - Rewrite N8N-WORKFLOWS.md: simplified, removed AI proxy tool references - Update README.md/README.fr.md: 37→22 tools, add auth mention - Update GUIDE.md/GUIDE.en.md: remove AI/API key tool tables, add auth - Update DEPLOY.md: SSE → Streamable HTTP in architecture diagram Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
51
GUIDE.en.md
51
GUIDE.en.md
@@ -51,7 +51,7 @@
|
||||
**Advanced tools:**
|
||||
- **Canvas/Lab** - whiteboard with drawing (Excalidraw)
|
||||
- **RSS feeds** - RSS feed integration
|
||||
- **MCP Server** - 37 tools to integrate with Claude Desktop, N8N, or any MCP client
|
||||
- **MCP Server** - 22 tools to integrate with Claude Desktop, N8N, or any MCP client
|
||||
|
||||
**Administration:**
|
||||
- **Authentication** via NextAuth.js v5 (credentials, registration, password reset)
|
||||
@@ -107,10 +107,10 @@ Momento/
|
||||
│ ├── Dockerfile # Multi-stage build (node:22-bullseye-slim)
|
||||
│ ├── docker-compose.yml # Standalone (postgres + app)
|
||||
│ └── .env.example # Local dev template
|
||||
├── mcp-server/ # MCP Server (37 tools)
|
||||
├── mcp-server/ # MCP Server (22 tools)
|
||||
│ ├── index.js # stdio mode (Claude Desktop)
|
||||
│ ├── index-sse.js # HTTP Streamable mode (N8N, remote)
|
||||
│ ├── tools.js # Definitions of the 37 MCP tools
|
||||
│ ├── tools.js # Definitions of the 22 MCP tools
|
||||
│ ├── auth.js # API key authentication
|
||||
│ ├── Dockerfile # MCP container (node:20-alpine)
|
||||
│ └── .env.example # MCP template
|
||||
@@ -433,9 +433,9 @@ Agents are also available in **AI Chat**: when web search is enabled, the chat a
|
||||
|
||||
The MCP server (Model Context Protocol, v3.1) allows AI agents to interact with your notes via a standardized protocol.
|
||||
|
||||
### Available Tools (37 tools)
|
||||
### Available Tools (22 tools)
|
||||
|
||||
**Notes (12):**
|
||||
**Notes (11):**
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
@@ -444,7 +444,6 @@ The MCP server (Model Context Protocol, v3.1) allows AI agents to interact with
|
||||
| `get_note` | Retrieve a specific note |
|
||||
| `update_note` | Modify an existing note |
|
||||
| `delete_note` | Delete a note |
|
||||
| `delete_all_notes` | Delete all notes |
|
||||
| `search_notes` | Search notes by content |
|
||||
| `move_note` | Move a note to a notebook |
|
||||
| `toggle_pin` | Pin/Unpin a note |
|
||||
@@ -472,36 +471,12 @@ The MCP server (Model Context Protocol, v3.1) allows AI agents to interact with
|
||||
| `update_label` | Modify a label |
|
||||
| `delete_label` | Delete a label |
|
||||
|
||||
**AI (11):**
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `generate_title_suggestions` | Title suggestions for a note |
|
||||
| `reformulate_text` | Reformulate text |
|
||||
| `generate_tags` | Generate tags for a note |
|
||||
| `suggest_notebook` | Suggest a notebook for a note |
|
||||
| `get_notebook_summary` | Notebook summary |
|
||||
| `get_memory_echo` | Memory echo - connections between notes |
|
||||
| `get_note_connections` | Connections of a note |
|
||||
| `dismiss_connection` | Dismiss a connection |
|
||||
| `fuse_notes` | Merge notes |
|
||||
| `batch_organize` | Automatic batch organization |
|
||||
| `suggest_auto_labels` | Suggest automatic labels |
|
||||
|
||||
**Reminders (1):**
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `get_due_reminders` | Retrieve due reminders |
|
||||
|
||||
**API Key Management (3):**
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `generate_api_key` | Generate an API key |
|
||||
| `list_api_keys` | List API keys |
|
||||
| `revoke_api_key` | Revoke an API key |
|
||||
|
||||
### stdio Mode (Claude Desktop, Cline)
|
||||
|
||||
Communication via stdin/stdout, ideal for local clients.
|
||||
@@ -520,15 +495,17 @@ Communication via stdin/stdout, ideal for local clients.
|
||||
|
||||
### HTTP Streamable Mode (N8N, Remote)
|
||||
|
||||
Communication via HTTP Streamable (replaces the legacy SSE), accessible over the network.
|
||||
Communication via HTTP Streamable, accessible over the network. API key authentication is enabled by default in Docker.
|
||||
|
||||
API keys are generated from **Settings > MCP** in the Memento web UI.
|
||||
|
||||
```bash
|
||||
# .env.docker
|
||||
MCP_MODE="sse"
|
||||
MCP_PORT="3001"
|
||||
# docker-compose.yml (pre-configured)
|
||||
MCP_MODE=sse
|
||||
MCP_REQUIRE_AUTH=true
|
||||
```
|
||||
|
||||
The server will be accessible at `http://localhost:3001`.
|
||||
The server will be accessible at `http://localhost:3001/mcp`.
|
||||
|
||||
#### HTTP Endpoints
|
||||
|
||||
@@ -552,8 +529,7 @@ curl http://localhost:3001/
|
||||
# .env.docker
|
||||
MCP_LOG_LEVEL=info # debug, info, warn, error
|
||||
MCP_REQUEST_TIMEOUT=30000 # Timeout in ms
|
||||
MCP_REQUIRE_AUTH=false # Enable authentication
|
||||
MCP_API_KEY="your-key" # API key if auth is enabled
|
||||
MCP_REQUIRE_AUTH=true # API key authentication
|
||||
APP_BASE_URL="http://localhost:3000" # App URL for links
|
||||
```
|
||||
|
||||
@@ -566,6 +542,7 @@ APP_BASE_URL="http://localhost:3000" # App URL for links
|
||||
1. Add an **"MCP Client"** node in N8N
|
||||
2. Select **"HTTP Streamable"** as transport
|
||||
3. Configure the endpoint: `http://memento-mcp:3001/mcp` (Docker) or `http://YOUR_IP:3001/mcp`
|
||||
4. Add **Header Auth**: `x-api-key` = your API key (generated from Settings > MCP)
|
||||
|
||||
### Pre-configured Workflows
|
||||
|
||||
|
||||
Reference in New Issue
Block a user