Skip to content

Commit 7a37933

Browse files
committed
update doc
1 parent 483ebb0 commit 7a37933

1 file changed

Lines changed: 58 additions & 39 deletions

File tree

README.md

Lines changed: 58 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ A Model Context Protocol (MCP) server that provides AI assistants with direct ac
44

55
![Mapbox MCP DevKit Server Demo](./assets/mcp_server_devkit.gif)
66

7+
## Table of Contents
8+
9+
- [Quick Start](#quick-start)
10+
- [Integration with Developer Tools](#integration-with-developer-tools)
11+
- [DXT Package Distribution](#dxt-package-distribution)
12+
- [Getting Your Mapbox Access Token](#getting-your-mapbox-access-token)
13+
- [Tools](#tools)
14+
- [Documentation Tools](#documentation-tools)
15+
- [Style Management Tools](#style-management-tools)
16+
- [Token Management Tools](#token-management-tools)
17+
- [Local Processing Tools](#local-processing-tools)
18+
- [Development](#development)
19+
- [Testing](#testing)
20+
- [Inspecting Server](#inspecting-server)
21+
- [Creating New Tools](#creating-new-tools)
22+
- [Environment Variables](#environment-variables)
23+
24+
## Quick Start
25+
726
## Integration with Developer Tools
827

928
Get started by integrating with your preferred AI development environment:
@@ -59,9 +78,35 @@ The `MAPBOX_ACCESS_TOKEN` environment variable is required. **Each tool requires
5978

6079
## Tools
6180

62-
### Mapbox API tools
81+
### Documentation Tools
82+
83+
#### get_latest_mapbox_docs_tool
84+
85+
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.
86+
87+
**Parameters:** None required
88+
89+
**Example:**
90+
91+
```json
92+
{}
93+
```
94+
95+
**Returns:** Complete Mapbox documentation including all current APIs, SDKs, tools, and developer resources. Always up-to-date and more reliable than web search results.
96+
97+
**Example prompts:**
98+
99+
- "What are the latest Mapbox APIs available for developers?"
100+
- "Show me all current Mapbox services and SDKs"
101+
- "I need up-to-date Mapbox documentation for my project"
102+
- "What mapping solutions does Mapbox offer for my tech stack?"
103+
- "Give me an overview of Mapbox's navigation and routing capabilities"
104+
- "Compare Mapbox web SDKs versus mobile SDKs"
105+
- "What's new in the Mapbox ecosystem?"
106+
107+
📖 **[See more examples and interactive demo →](./docs/mapbox-docs-tool-demo.md)**
63108

64-
#### Style Management Tools
109+
### Style Management Tools
65110

66111
Complete set of tools for managing Mapbox styles via the Styles API:
67112

@@ -115,7 +160,7 @@ Complete set of tools for managing Mapbox styles via the Styles API:
115160
- "Please generate a preview link for this style"
116161
- "Can you change the background to snow style?"
117162

118-
#### Token Management Tools
163+
### Token Management Tools
119164

120165
#### create-token
121166

@@ -189,33 +234,7 @@ List Mapbox access tokens for the authenticated user with optional filtering and
189234
- "List the 5 most recently modified tokens"
190235
- "Show all public tokens in my account"
191236

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-
218-
### Local processing tools
237+
### Local Processing Tools
219238

220239
#### GeoJSON Preview tool (Beta)
221240

@@ -341,11 +360,11 @@ An array of four numbers representing the bounding box: `[minX, minY, maxX, maxY
341360
- "Calculate the bounding box of this GeoJSON file" (then upload a .geojson file)
342361
- "What's the bounding box for the coordinates in the uploaded parks.geojson file?"
343362

344-
# Development
363+
## Development
345364

346-
## Testing
365+
### Testing
347366

348-
### Tool Snapshot Tests
367+
#### Tool Snapshot Tests
349368

350369
The project includes snapshot tests to ensure tool integrity and prevent accidental additions or removals of tools. These tests automatically discover all tools and create a snapshot of their metadata.
351370

@@ -386,9 +405,9 @@ npm test -- --updateSnapshot
386405

387406
**Important**: Only update snapshots when you have intentionally added, removed, or modified tools. Unexpected snapshot failures indicate accidental changes to the tool structure.
388407

389-
## Inspecting server
408+
### Inspecting Server
390409

391-
### Using Node.js
410+
#### Using Node.js
392411

393412
```sh
394413
# Build
@@ -398,7 +417,7 @@ npm run build
398417
npx @modelcontextprotocol/inspector node dist/index.js
399418
```
400419

401-
### Using Docker
420+
#### Using Docker
402421

403422
```sh
404423
# Build the Docker image
@@ -408,7 +427,7 @@ docker build -t mapbox-mcp-devkit .
408427
npx @modelcontextprotocol/inspector docker run -i --rm --env MAPBOX_ACCESS_TOKEN="YOUR_TOKEN" mapbox-mcp-devkit
409428
```
410429

411-
## Create new tool
430+
### Creating New Tools
412431

413432
```sh
414433
npx plop create-tool
@@ -458,9 +477,9 @@ src/tools/your-tool-name-tool/
458477
- Consistent with existing tools in the project
459478
- Enhanced TypeScript type safety
460479

461-
## Environment Variables
480+
### Environment Variables
462481

463-
### VERBOSE_ERRORS
482+
#### VERBOSE_ERRORS
464483

465484
Set `VERBOSE_ERRORS=true` to get detailed error messages from the MCP server. This is useful for debugging issues when integrating with MCP clients.
466485

0 commit comments

Comments
 (0)