Skip to content

Commit 72eba28

Browse files
authored
Add DXT package distribution support (#3)
* introduce dxt * 0.2.2 * remove the output
1 parent a91b4df commit 72eba28

File tree

4 files changed

+76
-3
lines changed

4 files changed

+76
-3
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,42 @@ Get started by integrating with your preferred AI development environment:
1111
- [Claude Code Integration](./docs/claude-code-integration.md) - Command-line development with Claude
1212
- [Claude Desktop Integration](./docs/claude-desktop-integration.md) - Desktop application integration
1313

14+
## DXT Package Distribution
15+
16+
This MCP server can be packaged as a DXT (Desktop Extension) file for easy distribution and installation. DXT is a standardized format for distributing local MCP servers, similar to browser extensions.
17+
18+
### Creating the DXT Package
19+
20+
To create a DXT package:
21+
22+
```bash
23+
# Install the DXT CLI tool
24+
npm install -g @anthropic-ai/dxt
25+
26+
# Build the server first
27+
npm run build
28+
29+
# Create the DXT package
30+
npx @anthropic-ai/dxt pack
31+
```
32+
33+
This will generate `mcp-devkit-server.dxt` using the configuration in `manifest.json`.
34+
35+
### Installing the DXT Package
36+
37+
Users can install the DXT package by:
38+
39+
1. Opening the `.dxt` file with a compatible application (e.g., Claude Desktop)
40+
2. Following the installation prompts
41+
3. Providing their Mapbox access token when prompted
42+
43+
The DXT package includes:
44+
45+
- Pre-built server code (`dist/index.js`)
46+
- Server metadata and configuration
47+
- User configuration schema for the Mapbox access token
48+
- Automatic environment variable setup
49+
1450
## Getting Your Mapbox Access Token
1551

1652
**A Mapbox access token is required to use this MCP server.**

manifest.json

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"dxt_version": "0.1",
3+
"name": "@mapbox/mcp-devkit-server",
4+
"display_name": "Mapbox MCP Server",
5+
"version": "0.2.1",
6+
"description": "Mapbox MCP devkit server",
7+
"author": {
8+
"name": "Mapbox, Inc."
9+
},
10+
"server": {
11+
"type": "node",
12+
"entry_point": "dist/index.js",
13+
"mcp_config": {
14+
"command": "node",
15+
"args": [
16+
"${__dirname}/dist/index.js"
17+
],
18+
"env": {
19+
"MAPBOX_ACCESS_TOKEN" : "${user_config.MAPBOX_ACCESS_TOKEN}"
20+
}
21+
}
22+
},
23+
"user_config": {
24+
"MAPBOX_ACCESS_TOKEN": {
25+
"type": "string",
26+
"title": "Mapbox access_token",
27+
"description": "Enter your Mapbox secret access token to get started, if you don't have one, please register from https://account.mapbox.com/access-tokens/",
28+
"required": true,
29+
"sensitive": true
30+
}
31+
},
32+
"license": "BSD-3-Clause",
33+
"repository": {
34+
"type": "git",
35+
"url": "https://github.com/mapbox/mcp-devkit-server.git"
36+
}
37+
}

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@mapbox/mcp-devkit-server",
3-
"version": "0.2.1-test-dryrun",
3+
"version": "0.2.2",
44
"description": "Mapbox MCP devkit server",
55
"main": "dist/index.js",
66
"module": "dist/index-esm.js",

0 commit comments

Comments
 (0)