Skip to content

Commit 483ebb0

Browse files
committed
add doc
1 parent 0ba8923 commit 483ebb0

5 files changed

Lines changed: 207 additions & 6 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,32 @@ List Mapbox access tokens for the authenticated user with optional filtering and
189189
- "List the 5 most recently modified tokens"
190190
- "Show all public tokens in my account"
191191

192+
#### get_latest_mapbox_docs_tool
193+
194+
Access the latest official Mapbox documentation directly from the source. This tool fetches comprehensive, up-to-date information about all Mapbox APIs, SDKs, and developer resources from docs.mapbox.com/llms.txt.
195+
196+
**Parameters:** None required
197+
198+
**Example:**
199+
200+
```json
201+
{}
202+
```
203+
204+
**Returns:** Complete Mapbox documentation including all current APIs, SDKs, tools, and developer resources. Always up-to-date and more reliable than web search results.
205+
206+
**Example prompts:**
207+
208+
- "What are the latest Mapbox APIs available for developers?"
209+
- "Show me all current Mapbox services and SDKs"
210+
- "I need up-to-date Mapbox documentation for my project"
211+
- "What mapping solutions does Mapbox offer for my tech stack?"
212+
- "Give me an overview of Mapbox's navigation and routing capabilities"
213+
- "Compare Mapbox web SDKs versus mobile SDKs"
214+
- "What's new in the Mapbox ecosystem?"
215+
216+
📖 **[See more examples and interactive demo →](./docs/mapbox-docs-tool-demo.md)**
217+
192218
### Local processing tools
193219

194220
#### GeoJSON Preview tool (Beta)

docs/mapbox-docs-tool-demo.md

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# Mapbox Documentation Tool Demo
2+
3+
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.
4+
5+
## 🎯 Tool Overview
6+
7+
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.
8+
9+
## 📝 Demo Prompts
10+
11+
Try these prompts with your AI assistant to see the tool in action:
12+
13+
### 1. Basic Documentation Queries
14+
15+
```
16+
What are the latest Mapbox APIs available for developers? I want to make sure I'm using the most current information.
17+
```
18+
19+
```
20+
Show me all current Mapbox services and SDKs available for developers.
21+
```
22+
23+
```
24+
I need the most up-to-date Mapbox documentation for my project planning.
25+
```
26+
27+
### 2. Development Planning
28+
29+
```
30+
I'm building a location-based mobile application. What Mapbox tools and APIs should I consider for my tech stack?
31+
```
32+
33+
```
34+
Help me understand the complete Mapbox developer platform - what options do I have?
35+
```
36+
37+
```
38+
What mapping solutions does Mapbox offer? I need to choose the right approach for my web application.
39+
```
40+
41+
### 3. Learning & Research
42+
43+
```
44+
Give me a comprehensive overview of Mapbox's current product ecosystem.
45+
```
46+
47+
```
48+
What are Mapbox's navigation and routing capabilities? Please provide current details.
49+
```
50+
51+
```
52+
Explain the differences between Mapbox web SDKs and mobile SDKs.
53+
```
54+
55+
```
56+
I'm new to Mapbox development. Can you give me an overview of their documentation and resources?
57+
```
58+
59+
### 4. Architecture Decisions
60+
61+
```
62+
For a real estate application with interactive maps and address search, what Mapbox APIs would be most relevant?
63+
```
64+
65+
```
66+
I need to implement mapping, geocoding, and turn-by-turn routing. What are my Mapbox options?
67+
```
68+
69+
```
70+
Compare Mapbox solutions for web applications versus mobile app implementations.
71+
```
72+
73+
```
74+
I'm building a logistics platform. What Mapbox services should I evaluate?
75+
```
76+
77+
### 5. Latest Information Requests
78+
79+
```
80+
What's new in the Mapbox ecosystem? I want to make sure I'm aware of all current offerings.
81+
```
82+
83+
```
84+
Are there any recent additions to Mapbox's API collection that I should know about?
85+
```
86+
87+
```
88+
Give me a current state overview of Mapbox developer tools and services.
89+
```
90+
91+
```
92+
I last used Mapbox 2 years ago. What has changed and what new services are available?
93+
```
94+
95+
## 🎪 Interactive Demo Session
96+
97+
Try this complete conversation flow:
98+
99+
**You:** "I'm planning a food delivery app with real-time tracking and route optimization. What current Mapbox services would be relevant?"
100+
101+
**Expected AI behavior:**
102+
103+
1. The AI should use `get_latest_mapbox_docs_tool`
104+
2. Provide specific recommendations based on current Mapbox offerings
105+
3. Include relevant APIs like Navigation SDK, Directions API, etc.
106+
107+
**Follow-up:** "Can you give me more details about the Navigation SDK options?"
108+
109+
**Expected AI behavior:**
110+
111+
1. Reference the already-fetched documentation
112+
2. Provide specific details about iOS/Android Navigation SDKs
113+
3. Include links to relevant documentation
114+
115+
## 🔍 What Makes These Prompts Effective
116+
117+
These prompts work because they:
118+
119+
-**Emphasize currency**: Use words like "latest", "current", "up-to-date"
120+
-**Request completeness**: Ask for "all", "comprehensive", "complete overview"
121+
-**Imply official sources**: Request "current offerings", "official documentation"
122+
-**Suggest comparison needs**: Multiple options require comprehensive data
123+
-**Focus on accuracy**: "make sure I'm using correct information"
124+
125+
## 🚀 Benefits Demonstration
126+
127+
### Before (using web search):
128+
129+
- May get outdated information
130+
- Fragmented results from multiple sources
131+
- Potential inaccuracies from third-party sites
132+
- Missing new APIs or changes
133+
134+
### After (using get_latest_mapbox_docs_tool):
135+
136+
- ✅ Always current official information
137+
- ✅ Complete ecosystem overview
138+
- ✅ Authoritative source (directly from Mapbox)
139+
- ✅ Includes latest APIs and features
140+
141+
## 🎛 Advanced Usage
142+
143+
### Complex Project Planning
144+
145+
```
146+
I need to architect a complete geospatial solution with mapping, search, routing, and analytics. Based on the latest Mapbox offerings, what would be the optimal combination of services?
147+
```
148+
149+
### Competitive Analysis
150+
151+
```
152+
I'm evaluating Mapbox versus other mapping platforms. What are all the current Mapbox capabilities I should consider in my analysis?
153+
```
154+
155+
### Migration Planning
156+
157+
```
158+
We're currently using [other platform]. What are all the Mapbox services that could replace our current functionality?
159+
```
160+
161+
## 💡 Pro Tips
162+
163+
1. **Use temporal keywords**: "latest", "current", "up-to-date", "recent"
164+
2. **Request comprehensiveness**: "all", "complete", "entire", "full"
165+
3. **Emphasize accuracy**: "official", "authoritative", "correct"
166+
4. **Avoid specific tool names**: Let the AI choose the right tool naturally
167+
5. **Context matters**: Mention your project needs to get relevant filtering
168+
169+
---
170+
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._

src/tools/__snapshots__/tool-naming-convention.test.ts.snap

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ exports[`Tool Naming Convention should maintain consistent tool list (snapshot t
3939
},
4040
{
4141
"className": "GetMapboxDocSourceTool",
42-
"description": "Fetch and return Mapbox documentation source collection content from llms.txt",
43-
"toolName": "get_mapbox_doc_source_tool",
42+
"description": "Get the latest official Mapbox documentation, APIs, SDKs, and developer resources directly from Mapbox. Always up-to-date, comprehensive coverage of all current Mapbox services including mapping, navigation, search, geocoding, and mobile SDKs. Use this for accurate, official Mapbox information instead of web search.",
43+
"toolName": "get_latest_mapbox_docs_tool",
4444
},
4545
{
4646
"className": "ListStylesTool",

src/tools/get-mapbox-doc-source-tool/GetMapboxDocSourceTool.test.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,12 @@ describe('GetMapboxDocSourceTool', () => {
1313
});
1414

1515
it('should have correct name and description', () => {
16-
expect(tool.name).toBe('get_mapbox_doc_source_tool');
17-
expect(tool.description).toContain('Fetch and return Mapbox documentation');
16+
expect(tool.name).toBe('get_latest_mapbox_docs_tool');
17+
expect(tool.description).toContain(
18+
'Get the latest official Mapbox documentation'
19+
);
20+
expect(tool.description).toContain('Always up-to-date');
21+
expect(tool.description).toContain('instead of web search');
1822
});
1923

2024
it('should successfully fetch documentation content', async () => {

src/tools/get-mapbox-doc-source-tool/GetMapboxDocSourceTool.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import {
77
export class GetMapboxDocSourceTool extends BaseTool<
88
typeof GetMapboxDocSourceSchema
99
> {
10-
name = 'get_mapbox_doc_source_tool';
10+
name = 'get_latest_mapbox_docs_tool';
1111
description =
12-
'Fetch and return Mapbox documentation source collection content from llms.txt';
12+
'Get the latest official Mapbox documentation, APIs, SDKs, and developer resources directly from Mapbox. Always up-to-date, comprehensive coverage of all current Mapbox services including mapping, navigation, search, geocoding, and mobile SDKs. Use this for accurate, official Mapbox information instead of web search.';
1313

1414
constructor() {
1515
super({ inputSchema: GetMapboxDocSourceSchema });

0 commit comments

Comments
 (0)