marcus/mcp-familywall
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clean up documentation (v0.8.2)

Browse Source 
- Roadmap: v0.8.x mpadditemtolist marked as 'cancelled – Family Wall native'
- CLAUDE.md: add recipe.recipeCategoryIdList and scope params to tables; add mpstar/isFavorite limitation section
- README.md: v0.8.0 → v0.8.2; get_lists clarification (returns all circles without scope); get_recipe_categories standard categories list
- SPEC.md: update recipe categories explanation, taskupdatelist scope param, offene punkte clarification
This commit is contained in:
Marcus van Elst
2026-04-17 07:38:38 +02:00
parent d41ac8e763
commit 36448e68e0
3 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+8 -2
View File
@@ -54,8 +54,8 @@ und wird in Claude Desktop eingebunden.
- v0.8.0: Rezept-Kategorien (get_recipe_categories, create_recipe + category_ids, update_recipe + category_ids) ✓ - v0.8.0: Rezept-Kategorien (get_recipe_categories, create_recipe + category_ids, update_recipe + category_ids) ✓
- v0.8.1: Bugfixes (recipe categories) ✓ - v0.8.1: Bugfixes (recipe categories) ✓
- v0.8.2: get_lists() ohne scope → alle Kreise ✓ ← aktuell - v0.8.2: get_lists() ohne scope → alle Kreise ✓ ← aktuell
- v0.8.x: mpadditemtolist (gestrichen – Family Wall kann das nativ)
- v0.9.x: Erinnerungen + Wiederholungen (Premium-Account erforderlich) - v0.9.x: Erinnerungen + Wiederholungen (Premium-Account erforderlich)
- v0.8.x: mpadditemtolist (Zutaten → Einkaufsliste)
- v2.0: Schreibzugriff auf Wall-Posts (Erstellen, Kommentieren) - v2.0: Schreibzugriff auf Wall-Posts (Erstellen, Kommentieren)
@@ -146,10 +146,11 @@ Fehler bei falschen Parametern kommen nicht immer auf Top-Level:
| `taskcategorydelete` | `id` | metaId der Kategorie | | `taskcategorydelete` | `id` | metaId der Kategorie |
| `taskcreatelist` | `name`, `taskListType`, `sharedToAll`, `color`, `emoji`, `scope` | `scope`: Kreis-metaId für nicht-primäre Kreise | | `taskcreatelist` | `name`, `taskListType`, `sharedToAll`, `color`, `emoji`, `scope` | `scope`: Kreis-metaId für nicht-primäre Kreise |
| `taskgettasklists` | `scope` | Kreis-metaId; ohne scope → primärer Kreis | | `taskgettasklists` | `scope` | Kreis-metaId; ohne scope → primärer Kreis |
| `taskupdatelist` | `metaId`, `name`, `color`, `emoji` | `metaId` ⚠️ nicht `id`!; Partial Update | | `taskupdatelist` | `metaId`, `name`, `color`, `emoji`, `scope` | `metaId` ⚠️ nicht `id`!; `scope`: Kreis-metaId für sekundäre Kreise; Partial Update |
| `taskdeletelist` | `id`, `scope` | `scope`: Kreis-metaId für sekundäre Kreise | | `taskdeletelist` | `id`, `scope` | `scope`: Kreis-metaId für sekundäre Kreise |
| `mprecipeput` | `recipe.name`, `recipe.isRecipe="true"`, `recipe.description`, `recipe.ingredients`, `recipe.instructions`, `recipe.prepTime`, `recipe.cookTime`, `recipe.serves`, `recipe.url` | Alle mit `recipe.`-Prefix! | | `mprecipeput` | `recipe.name`, `recipe.isRecipe="true"`, `recipe.description`, `recipe.ingredients`, `recipe.instructions`, `recipe.prepTime`, `recipe.cookTime`, `recipe.serves`, `recipe.url` | Alle mit `recipe.`-Prefix! |
| `mprecipeput` (Update) | zusätzlich `recipe.metaId` | Vorhandene ID → Update statt Create | | `mprecipeput` (Update) | zusätzlich `recipe.metaId` | Vorhandene ID → Update statt Create |
| `mprecipeput` (Kategorien) | `recipe.recipeCategoryIdList` | Mehrfach sendbar; leerer String `""` entfernt alle Kategorien |
| `metasync` (Rezepte lesen) | `id="recipe"` | liefert `a00.r.r.updatedCreated[]` | | `metasync` (Rezepte lesen) | `id="recipe"` | liefert `a00.r.r.updatedCreated[]` |
| `acccreatefamily` | `name` | liefert numerische Kreis-ID als String in `a00.r.r` | | `acccreatefamily` | `name` | liefert numerische Kreis-ID als String in `a00.r.r` |
| `accinvite` | `familyId`, `identifier`, `role="Unknown"`, `firstname` | nur für neue FW-Accounts | | `accinvite` | `familyId`, `identifier`, `role="Unknown"`, `firstname` | nur für neue FW-Accounts |
@@ -163,6 +164,11 @@ Eigene Posts können nicht geliked werden. API antwortet 200, macht aber nichts.
Service Worker verschlüsselt den Unlike-Request-Body. Service Worker verschlüsselt den Unlike-Request-Body.
Endpoint unbekannt. `like_post(like=False)` gibt Fehlermeldung zurück. Endpoint unbekannt. `like_post(like=False)` gibt Fehlermeldung zurück.
### mpstar / Rezept-Favorit
Service Worker fängt `mpstar` ab. `metamood` funktioniert nur auf
fremde Inhalte (Self-Reaction-Restriction). Eigene Rezepte
können nicht als Favorit markiert werden. Siehe SPEC.md § Offene Punkte.
## Test-Credentials (nur für Entwicklung) ## Test-Credentials (nur für Entwicklung)
README.md
+3 -3
View File
@@ -2,19 +2,19 @@
MCP server for [Family Wall](https://www.familywall.com) -- read and manage your family's circles, lists, tasks, and recipes directly from Claude. MCP server for [Family Wall](https://www.familywall.com) -- read and manage your family's circles, lists, tasks, and recipes directly from Claude.
## Features (v0.8.0) ## Features (v0.8.2)
### Read ### Read
- `get_circles` -- list all family circles - `get_circles` -- list all family circles
- `get_members` -- list members of a circle (or all circles) - `get_members` -- list members of a circle (or all circles)
- `get_lists` -- list all task lists (includes `emoji`, `color`, `circle_id`; `null` when unset); optional `scope` parameter filters by circle metaId or circle name - `get_lists` -- list all task lists (includes `emoji`, `color`, `circle_id`; `null` when unset); without scope parameter returns lists from **all circles**; optional `scope` parameter filters by circle metaId or circle name
- `get_tasks` -- list tasks in a specific list (includes `category_id`, `due_date`, `assignee_ids`) - `get_tasks` -- list tasks in a specific list (includes `category_id`, `due_date`, `assignee_ids`)
- `get_categories` -- list categories for a list (locale-filtered; custom categories always included; `custom` flag marks user-created ones) - `get_categories` -- list categories for a list (locale-filtered; custom categories always included; `custom` flag marks user-created ones)
- `get_activities` -- list recent wall activities (author resolved to display name) - `get_activities` -- list recent wall activities (author resolved to display name)
- `get_recipes` -- list all family recipes (compact summary: id, name, prep/cook time, serves) - `get_recipes` -- list all family recipes (compact summary: id, name, prep/cook time, serves)
- `get_recipe` -- get a single recipe in full detail (ingredients, instructions, ingredients_parsed, category_ids, etc.) - `get_recipe` -- get a single recipe in full detail (ingredients, instructions, ingredients_parsed, category_ids, etc.)
- `get_recipe_categories` -- list all available recipe categories (extracts from existing recipes) - `get_recipe_categories` -- list all available recipe categories (always returns all 5 standard categories: Bei Kindern beliebt, Wirklich einfach, Nachspeisen, Schmeckt toll, Gemüse; plus any additional categories found in existing recipes)
### Write (with confirmation prompt) ### Write (with confirmation prompt)
SPEC.md
+5 -5
View File
@@ -326,6 +326,7 @@ POST https://api.familywall.com/api/taskupdatelist
| `name` | nein | Neuer Listen-Name | | `name` | nein | Neuer Listen-Name |
| `color` | nein | Hex-Farbwert z.B. `"#E53935"` | | `color` | nein | Hex-Farbwert z.B. `"#E53935"` |
| `emoji` | nein | Unicode-Emoji z.B. `"🧪"` | | `emoji` | nein | Unicode-Emoji z.B. `"🧪"` |
| `scope` | nein | Kreis-metaId für sekundäre Kreise; automatisch aus metaId abgeleitet |
**Hinweis:** Nur übergebene Felder werden geändert (Partial Update). **Hinweis:** Nur übergebene Felder werden geändert (Partial Update).
Felder die nicht mitgeschickt werden bleiben auf dem Server unverändert. Felder die nicht mitgeschickt werden bleiben auf dem Server unverändert.
@@ -677,10 +678,9 @@ a00.r.r
``` ```
**Category IDs** have format `category/<family_id>_<index>`. Categories are family-wide. **Category IDs** have format `category/<family_id>_<index>`. Categories are family-wide.
Premium accounts have additional categories beyond the 5 available in free tier. Standard categories (_2 to _6) are always available and derived from the family's metaId.
No API endpoint needed – IDs are constructed as `category/<familyId>_<N>`.
**Limitation:** Currently no API endpoint to list all available categories. Categories are Premium accounts may have additional categories beyond the 5 available in free tier.
discovered by examining existing recipes or hardcoding known IDs.
### `metamood` – Rezept-Reaktion (Stern setzen) ### `metamood` – Rezept-Reaktion (Stern setzen)
POST https://api.familywall.com/api/metamood POST https://api.familywall.com/api/metamood
@@ -734,5 +734,5 @@ bevor er den Server erreicht. Die Transformation ist ohne Service-Worker-Analyse
- Erinnerungen (reminder) – nur Premium-Account - Erinnerungen (reminder) – nur Premium-Account
- Wiederholungen (repeat) – nur Premium-Account - Wiederholungen (repeat) – nur Premium-Account
- Rezept-Kategorien-Listing-Endpoint (derzeit keine API, müssen aus Rezepten extrahiert werden) - Rezept-Kategorien-Listing-Endpoint (derzeit keine API, müssen aus Rezepten extrahiert werden)
- mpadditemtolist (Zutaten aus Rezept → Einkaufsliste) - mpadditemtolist (nicht nötig – Family Wall kann das nativ über die Web-App)
- Einladung bestehender FamilyWall-Nutzer (accinvite nur für neue Accounts) - Einladung bestehender FamilyWall-Nutzer (accinvite nur für neue Accounts)