docs: update MCP tools reference for #667 additions#738
Closed
jphein wants to merge 4 commits intoMemPalace:developfrom
Closed
docs: update MCP tools reference for #667 additions#738jphein wants to merge 4 commits intoMemPalace:developfrom
jphein wants to merge 4 commits intoMemPalace:developfrom
Conversation
jphein
added a commit
to jphein/mempalace
that referenced
this pull request
Apr 12, 2026
Co-Authored-By: Claude Opus 4.6 <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the VitePress documentation to reflect the expanded MCP tool surface area introduced in #667, and documents new search parameters/response fields.
Changes:
- Update docs to reflect 24 MCP tools (was 19) and adjust homepage copy accordingly.
- Extend
mempalace_searchdocumentation withmax_distance+contextparameters and adddistanceto response examples. - Add reference entries for the new drawer/settings tools (
get/list/update drawer,hook_settings,memories_filed_away).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| website/reference/mcp-tools.md | Adds new tool reference sections and updates mempalace_search parameter/return docs. |
| website/index.md | Updates the homepage feature card text from 19 to 24 tools and expands the feature description. |
| website/guide/searching.md | Updates search behavior description to cosine distance and documents max_distance, distance, and filtering behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
49
to
63
| ### `mempalace_search` | ||
|
|
||
| Semantic search. Returns verbatim drawer content with similarity scores. | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `query` | string | **Yes** | What to search for | | ||
| | `limit` | integer | No | Max results (default: 5) | | ||
| | `query` | string | **Yes** | Short search query — keywords or a question. Max 200 chars recommended. | | ||
| | `limit` | integer | No | Max results (default: 5, max: 100) | | ||
| | `wing` | string | No | Filter by wing | | ||
| | `room` | string | No | Filter by room | | ||
| | `max_distance` | number | No | Max cosine distance threshold (0=identical, 2=opposite). Results further than this are dropped. Default 1.5. Set to 0 to disable. | | ||
| | `context` | string | No | Background context for the search. Not used for embedding — only for future re-ranking. | | ||
|
|
||
| **Returns:** `{ query, filters, results: [{ text, wing, room, source_file, similarity }] }` | ||
| **Returns:** `{ query, filters, results: [{ text, wing, room, source_file, similarity, distance }] }` | ||
|
|
Comment on lines
+119
to
+128
| ### `mempalace_get_drawer` | ||
|
|
||
| Fetch a single drawer by ID — returns full content and metadata. | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `drawer_id` | string | **Yes** | ID of the drawer to fetch | | ||
|
|
||
| **Returns:** `{ drawer_id, content, wing, room, source_file, metadata }` | ||
|
|
Comment on lines
+131
to
+143
| ### `mempalace_list_drawers` | ||
|
|
||
| List drawers with pagination. Optional wing/room filter. Returns IDs, wings, rooms, and content previews. | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `wing` | string | No | Filter by wing | | ||
| | `room` | string | No | Filter by room | | ||
| | `limit` | integer | No | Max results per page (default: 20, max: 100) | | ||
| | `offset` | integer | No | Offset for pagination (default: 0) | | ||
|
|
||
| **Returns:** `{ drawers: [{ id, wing, room, preview }], total, offset, limit }` | ||
|
|
Comment on lines
+146
to
+158
| ### `mempalace_update_drawer` | ||
|
|
||
| Update an existing drawer's content and/or metadata (wing, room). Returns error if drawer not found. | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `drawer_id` | string | **Yes** | ID of the drawer to update | | ||
| | `content` | string | No | New content (omit to keep existing) | | ||
| | `wing` | string | No | New wing (omit to keep existing) | | ||
| | `room` | string | No | New room (omit to keep existing) | | ||
|
|
||
| **Returns:** `{ success, drawer_id, updated_fields }` | ||
|
|
Comment on lines
+163
to
+173
| ### `mempalace_hook_settings` | ||
|
|
||
| Get or set hook behavior. Call with no arguments to view current settings. | ||
|
|
||
| | Parameter | Type | Required | Description | | ||
| |-----------|------|----------|-------------| | ||
| | `silent_save` | boolean | No | True = silent direct save, False = legacy blocking MCP calls | | ||
| | `desktop_toast` | boolean | No | True = show desktop notification via notify-send | | ||
|
|
||
| **Returns:** `{ silent_save, desktop_toast }` | ||
|
|
Comment on lines
+176
to
+183
| ### `mempalace_memories_filed_away` | ||
|
|
||
| Check if a recent palace checkpoint was saved. Returns message count and timestamp. | ||
|
|
||
| **Parameters:** None | ||
|
|
||
| **Returns:** `{ last_save, message_count, timestamp }` | ||
|
|
Comment on lines
43
to
+47
| - icon: | ||
| src: /icons/wrench.svg | ||
| alt: 19 MCP Tools | ||
| title: 19 MCP Tools | ||
| details: MCP tools expose search, filing, knowledge graph, graph navigation, and diary operations to compatible clients. | ||
| title: 24 MCP Tools | ||
| details: MCP tools expose search, filing, knowledge graph, graph navigation, diary, and settings operations to compatible clients. |
- Add 5 missing tools: get_drawer, list_drawers, update_drawer, hook_settings, memories_filed_away (shipped in MemPalace#667) - Add max_distance and context params to mempalace_search - Add distance field to search response examples - Update tool count from 19 to 24 Co-Authored-By: Claude Opus 4.6 <[email protected]>
- Update 19 → 24 in four places (intro, heading, file table, tree) - Add get_drawer, list_drawers, update_drawer to Palace (write) table - Add Settings section with hook_settings and memories_filed_away Co-Authored-By: Claude Opus 4.6 <[email protected]>
- search: add keyword_fallback, total_before_filter, sanitizer fields
- get_drawer: source_file is inside metadata, not top-level
- list_drawers: use drawer_id/content_preview/count field names
- update_drawer: returns wing/room, not updated_fields; document noop
- hook_settings: response is { success, settings: {...} }
- memories_filed_away: returns status/message/count/timestamp
- index.md: fix alt text "19 MCP Tools" → "24 MCP Tools"
Co-Authored-By: Claude Opus 4.6 <[email protected]>
jphein
force-pushed
the
docs/update-mcp-tools-reference
branch
from
2fca765 to
6f2da54
Compare
Co-Authored-By: Claude Opus 4.6 <[email protected]>
igorls
added
area/mcp
Collaborator
Author
|
Closing — the README and website docs were fully rewritten for v3.3.0, making this MCP tools reference update stale. The new docs already cover the tools added in #667. |
jphein
added a commit
to jphein/mempalace
that referenced
this pull request
Apr 16, 2026
README: replace 460-line upstream-mirroring README with focused fork-only content — what's different, what's merged, what's superseded, PR status. Points to upstream README for full feature docs. CLAUDE.md: bump version 3.2.0 → 3.3.0, test count 715 → 858, remove fork changes absorbed by upstream, update PR table (close MemPalace#662, MemPalace#738), simplify hook architecture notes for v3.3.0 alignment. Co-Authored-By: Claude Opus 4.6 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
get_drawer,list_drawers,update_drawer,hook_settings,memories_filed_awaymax_distanceandcontextparameters tomempalace_searchdocs (also from feat: new MCP tools — get/list/update drawer, hook settings, export (resolves #635) #667)distancefield to search response examplesTest plan
🤖 Generated with Claude Code