Skip to content

Commit 3db477a

Browse files
committed
update doc
1 parent 7a37933 commit 3db477a

1 file changed

Lines changed: 35 additions & 1 deletion

File tree

docs/mapbox-docs-tool-demo.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This demo showcases the `get_latest_mapbox_docs_tool` and provides example prompts that will trigger the AI assistant to use this tool instead of web search.
44

5+
> **⚠️ Important Note**: Different MCP clients (Claude Desktop, Claude Code, etc.) and different LLM models may exhibit varying behavior when selecting tools. The examples below are demonstrations of intended behavior and may not work identically across all environments. Tool selection depends on the specific AI model's training, the MCP client implementation, and system prompts used.
6+
57
## 🎯 Tool Overview
68

79
The `get_latest_mapbox_docs_tool` automatically fetches the latest official Mapbox documentation from `docs.mapbox.com/llms.txt`. This ensures AI assistants always have access to current, authoritative information about Mapbox APIs and services.
@@ -112,6 +114,14 @@ Try this complete conversation flow:
112114
2. Provide specific details about iOS/Android Navigation SDKs
113115
3. Include links to relevant documentation
114116

117+
> **📝 Note**: The actual behavior may vary depending on your MCP client and AI model. Some models might:
118+
>
119+
> - Choose web search instead of the documentation tool
120+
> - Use the tool but focus on different aspects of the documentation
121+
> - Require more specific prompting to trigger the desired tool selection
122+
>
123+
> If the tool isn't being selected, try using more explicit language like "I need the most current official information" or "please use the latest documentation."
124+
115125
## 🔍 What Makes These Prompts Effective
116126

117127
These prompts work because they:
@@ -166,6 +176,30 @@ We're currently using [other platform]. What are all the Mapbox services that co
166176
4. **Avoid specific tool names**: Let the AI choose the right tool naturally
167177
5. **Context matters**: Mention your project needs to get relevant filtering
168178

179+
### 🔧 **Troubleshooting Tool Selection**
180+
181+
If the AI is not using the documentation tool:
182+
183+
- **Be more explicit**: "I need official Mapbox documentation" or "Please use the latest source"
184+
- **Emphasize currency**: "Make sure you have the most current information"
185+
- **Request authority**: "I want authoritative information directly from Mapbox"
186+
- **Try rephrasing**: Different models respond to different prompt styles
187+
- **Check your MCP setup**: Ensure the tool is properly registered and available
188+
189+
### 🌐 **Environment Considerations**
190+
191+
**Claude Desktop vs Claude Code**: Different interfaces may have varying tool selection behaviors.
192+
193+
**Model Versions**: Newer models may be better at tool selection than older ones.
194+
195+
**System Prompts**: Some MCP clients may have system prompts that influence tool selection preferences.
196+
169197
---
170198

171-
_This demo file is designed to help developers and AI assistants make the most of the Mapbox Documentation Tool. The prompts are crafted to naturally trigger the correct tool selection while providing valuable, current information._
199+
## 📋 **Disclaimer**
200+
201+
_This demo file provides **examples and suggestions** for using the Mapbox Documentation Tool. The prompts are crafted to **ideally** trigger correct tool selection, but actual behavior **will vary** across different MCP clients, AI models, and system configurations._
202+
203+
_**Results may vary**: Tool selection depends on many factors including model training, client implementation, and system prompts. These examples show **intended behavior** rather than guaranteed outcomes._
204+
205+
_Use these examples as **starting points** and adjust your prompts based on your specific environment and the AI assistant's responses._

0 commit comments

Comments
 (0)