Skip to content

Commit 1a4e46e

Browse files
PCfVWPCfVW
committed
docs(mcp-patterns): add comprehensive MCP Design Pattern documentation
- Created new docs/user-guide/mcp-design-patterns.md (925 lines) - Pattern 1: Progressive Tool Discovery (arango_search_tools, arango_list_tools_by_category) - Pattern 2: Context Switching (arango_switch_context, arango_get_active_context, arango_list_contexts) - Pattern 3: Tool Unloading (arango_advance_workflow_stage, arango_get_tool_usage_stats, arango_unload_tools) - Complete workflow examples demonstrating 98.7% token savings - Decision matrix for pattern selection - Best practices and error handling guidance - Updated docs/user-guide/tools-reference.md - Added section 11: MCP Design Pattern Tools (9 tools) - Complete API documentation for all 9 pattern tools - Updated tool count from 34 to 43 tools - Added cross-reference to MCP Design Patterns Guide - Updated README.md - Updated tool count from 34 to 43 tools (10 categories) - Added MCP Design Patterns feature highlight - Added Quick Link to MCP Design Patterns Guide - Listed all 9 new tools in Available Tools section - Updated docs/README.md - Added MCP Design Patterns Guide to User Guide section - Updated tool count from 34 to 43 tools - Updated expected tool count in Quick Start section Inspired by Anthropic's research on code execution with MCP demonstrating up to 98.7% token savings through progressive tool discovery
1 parent 870462d commit 1a4e46e

File tree

4 files changed

+1455
-13
lines changed

4 files changed

+1455
-13
lines changed

‎README.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,16 @@ A production-ready Model Context Protocol (MCP) server exposing advanced ArangoD
1919

2020
📖 **Tools Reference:** [https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/tools-reference.md](https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/tools-reference.md)
2121

22+
🎯 **MCP Design Patterns:** [https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/mcp-design-patterns.md](https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/mcp-design-patterns.md)
23+
2224
🐛 **Issues:** [https://github.com/PCfVW/mcp-arango-async/issues](https://github.com/PCfVW/mcp-arango-async/issues)
2325

2426
---
2527

2628
## Features
2729

28-
✅ **34 MCP Tools** - Complete ArangoDB operations (queries, collections, indexes, graphs)
30+
✅ **43 MCP Tools** - Complete ArangoDB operations (queries, collections, indexes, graphs)
31+
✅ **MCP Design Patterns** - Progressive discovery, context switching, tool unloading (98.7% token savings)
2932
✅ **Graph Management** - Create, traverse, backup/restore named graphs
3033
✅ **Content Conversion** - JSON, Markdown, YAML, and Table formats
3134
✅ **Backup/Restore** - Collection and graph-level backup with validation
@@ -43,9 +46,9 @@ A production-ready Model Context Protocol (MCP) server exposing advanced ArangoD
4346
┌────────────────────┐ ┌─────────────────────┐ ┌──────────────────┐
4447
│ MCP Client │ │ ArangoDB MCP │ │ ArangoDB │
4548
│ (Claude, Augment) │─────▶│ Server (Python) │─────▶│ (Docker) │
46-
│ │ │ • 34 Tools │ │ • Multi-Model │
49+
│ │ │ • 43 Tools │ │ • Multi-Model │
4750
│ │ │ • Graph Mgmt │ │ • Graph Engine │
48-
│ │ │ • Analytics │ │ • AQL Engine │
51+
│ │ │ • MCP Patterns │ │ • AQL Engine │
4952
└────────────────────┘ └─────────────────────┘ └──────────────────┘
5053
```
5154

@@ -221,7 +224,7 @@ LOG_LEVEL=INFO # DEBUG, INFO, WARNING, ERROR
221224

222225
## Available Tools
223226

224-
The server exposes **34 MCP tools** organized into 9 categories:
227+
The server exposes **43 MCP tools** organized into 10 categories:
225228

226229
### Core Data Operations (7 tools)
227230
- `arango_query` - Execute AQL queries
@@ -275,8 +278,21 @@ The server exposes **34 MCP tools** organized into 9 categories:
275278
- `arango_graph_statistics` - Graph statistics
276279
- `arango_database_status` - Database status
277280

281+
### MCP Design Pattern Tools (9 tools)
282+
- `arango_search_tools` - Search for tools by keywords
283+
- `arango_list_tools_by_category` - List tools by category
284+
- `arango_switch_context` - Switch workflow context
285+
- `arango_get_active_context` - Get active context
286+
- `arango_list_contexts` - List all contexts
287+
- `arango_advance_workflow_stage` - Advance workflow stage
288+
- `arango_get_tool_usage_stats` - Get tool usage statistics
289+
- `arango_unload_tools` - Unload specific tools
290+
- `arango_graph_traversal` - Alias for arango_traverse
291+
278292
📖 **Complete tools reference:** [https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/tools-reference.md](https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/tools-reference.md)
279293

294+
📖 **MCP Design Patterns Guide:** [https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/mcp-design-patterns.md](https://github.com/PCfVW/mcp-arango-async/blob/master/docs/user-guide/mcp-design-patterns.md)
295+
280296
---
281297

282298
## Use Case Example: Codebase Graph Analysis

‎docs/README.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,15 @@ Start here if you're new to mcp-arangodb-async.
4949
Complete reference for using the server.
5050

5151
1. **[Tools Reference](user-guide/tools-reference.md)** (30 min)
52-
- All 34 MCP tools documented
53-
- 9 categories: CRUD, Queries, Collections, Indexes, Graphs, Analytics, Backup, Content, Database
52+
- All 43 MCP tools documented
53+
- 10 categories: CRUD, Queries, Collections, Indexes, Graphs, Analytics, Backup, Content, Database, MCP Patterns
5454
- Arguments, return values, examples
55+
56+
2. **[MCP Design Patterns Guide](user-guide/mcp-design-patterns.md)** (45-60 min)
57+
- Progressive Tool Discovery - Load tools on-demand (98.7% token savings)
58+
- Context Switching - Switch between workflow-specific tool sets
59+
- Tool Unloading - Remove tools as workflows progress
60+
- Combining patterns for complex workflows
5561
- Toolset configuration (baseline vs full)
5662

5763
2. **[Troubleshooting Guide](user-guide/troubleshooting.md)** (20 min)
@@ -247,7 +253,7 @@ python -m mcp_arangodb_async --health
247253
List all available ArangoDB tools
248254
```
249255

250-
**Expected:** Claude lists 34 tools in 9 categories.
256+
**Expected:** Claude lists 43 tools in 10 categories.
251257

252258
---
253259

0 commit comments

Comments
 (0)