api-design
/api-design
Pilnuje projektowania nowych narzędzi, parametrów i endpointów w serwerze Apple Mail MCP: drzewo decyzyjne przeciw rozrostowi narzędzi i katalog antywzorców.
- Autor
- s-morgan-jeffries ↗
- Repozytorium
- apple-mail-fast-mcp ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 07.09.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 07.09.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Pilnuje projektowania nowych narzędzi, parametrów i endpointów w serwerze Apple Mail MCP: drzewo decyzyjne przeciw rozrostowi narzędzi i katalog antywzorców.
Oryginalny opis (EN)
Use BEFORE adding any new tool, parameter, or endpoint to the Apple Mail MCP server. Also use when considering API changes, evaluating feature requests, or when tempted to create a specialized operation. Contains the decision tree that prevents tool sprawl and the anti-pattern catalog.
Jak działa
- Decision Tree: Use BEFORE Adding Any Tool
- Anti-Patterns (Never Do These)
- Response Format Rules
- Tool Naming Convention
- Adding a New Tool Checklist
Podgląd SKILL.md
---
name: api-design
description: Use BEFORE adding any new tool, parameter, or endpoint to the Apple Mail MCP server. Also use when considering API changes, evaluating feature requests, or when tempted to create a specialized operation. Contains the decision tree that prevents tool sprawl and the anti-pattern catalog.
---
# Apple Mail MCP API Design
The current API has 17 tools organized into 4 phases. Tool count should grow slowly and deliberately. Every new tool request must pass through the decision tree.
## Decision Tree: Use BEFORE Adding Any Tool
```
Can an existing tool handle this with current parameters? (70% of cases: YES)
|-- Searching with a new filter? -> Add parameter to search_messages()
|-- Reading with different format? -> Add parameter to get_messages()
|-- Sending/composing with new options? -> Extend create_draft() or update_draft()
|
Can an existing tool handle this with a NEW parameter? (20% of cases: YES)
|-- Example: search by date range -> add date_from, date_to to search_messages()
|-- Example: search flagged only -> add is_flagged to search_messages()
|
Is this truly a distinct operation? (10% of cases: MAYBE)
|-- Different Mail.app object? (accounts, rules, smart mailboxes)
|-- Different action type? (not CRUD on messages/mailboxes)
|
If NO to all three: You might need a new tool. This is rare.
```
## Anti-Patterns (Never Do These)
### Field-Specific Tools
```python
# WRONG - creates tool sprawl
mark_as_flagged(message_id)
mark_as_unflagged(message_id)
mark_as_junk(message_id)
# RIGHT - one CRUD-style update tool with patch semantics
update_message(message_ids, read_status=True)
update_message(message_ids, flag_color="red")
update_message(message_ids, destination_mailbox="Archive", account="Gmail")
```
### Specialized Search Tools
```python
# WRONG - each filter becomes a tool
get_unread_messages()
get_flagged_messages()
get_messages_from_sender()
# RIGHT - parameters on existing search
search_messages(read_status="unread")
search_messages(is_flagged=True)
search_messages(sender_contains="user@example.com")
```
### Formatted Text Returns
```python
# WRONG - returns human-readable string
def list_mailboxes():
return "Inbox (42 messages)\nSent (15 messages)"
# RIGHT - returns structured data
def list_mailboxes():
return {"success": True, "mailboxes": [{"name": "Inbox", "count": 42}, ...]}
```
## Response Format Rules
1. **Always return `dict[str, Any]`** with `"success": bool`
2. **Errors include `"error"` (message) and `"error_type"` (category)**
3. **Never return formatted text strings** — return structured data
4. **Include context fields** — e.g., `"messages_found": 5` alongside the results
## Tool Naming Convention
- Verb + noun: `search_messages`, `create_draft`, `delete_messages`
- Plural when accepting lists: `delete_messages`, `get_messages`
- CRUD-style for multi-field mutation: `update_message(read_status, flag_color, destination_mailbox, ...)` over per-field verbs (`mark_as_read`, `flag_message`, `move_messages`). Patch semantics — unset fields are unchanged.
## Adding a New Tool Checklist
1. Verify it doesn't fit in an existing tool (run through decision tree above)
2. Write unit tests (mock AppleScript)
3. Write integration tests (real Mail.app)
4. Implement in `mail_connector.py`
5. Expose in `server.py`
6. Run `./scripts/check_client_server_parity.sh`
7. Update `docs/reference/TOOLS.md`
8. Add blind eval scenarios if tool has non-obvious parameters
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · s-morgan-jeffries/apple-mail-fast-mcp | 100 | MIT |
| proyecto26/system-design-skills | 100 | MIT |
| ericrisco/rsc-harness | 100 | MIT |
| Sanit-mann/The-Insectoids | 100 | MIT |
| yonatangross/orchestkit | 100 | MIT |
| travisjneuman/.claude | 100 | MIT |
| wrongstack/wrongstack | 100 | MIT |
| jelvodev/yaap | 100 | MIT |
| komluk/scaffolding | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki 8a97d6d1a60d (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100build-mcp-server
Prowadzi przez tworzenie serwera MCP: wyjaśnia przypadek użycia, dobiera model wdrożenia i wzorzec projektowania narzędzi. - 100mcp2cli
Zamienia dowolny serwer MCP, specyfikację OpenAPI lub endpoint GraphQL w CLI: odkrywanie narzędzi i endpointów, wywoływanie operacji i generowanie nowego skilla z API. - 100b2c-mcp-server
Wskazuje, jak skonfigurować serwer MCP dla B2C Commerce: wybór zestawów narzędzi, dobór narzędzia do zadania i katalog skilli. - 90tool-schema-designer
Projektuje definicje narzędzi dla Claude: zamienia endpoint, kontroler lub OpenAPI na schemat wywołań dla API, Agent SDK albo serwera MCP. - 84audit
Audytuje definicje narzędzi MCP pod kątem jakości: opisy parametrów, adnotacje i limity rozmiaru wyników. - 100mcp-tool
Optymalizuje zestaw narzędzi zewnętrznego serwera MCP, gdy agent źle wybiera narzędzia lub błędnie wypełnia argumenty: opisy narzędzi, dokumentacja parametrów, przykłady i dobór eksponowanych narzędzi.