You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
planet-mcp is a local [mcp](https://modelcontextprotocol.io/introduction) server powered by the [Planet SDK](https://github.com/planetlabs/planet-client-python). It allows an AI agent/chat to interact with the Planet API using
4
-
the Planet CLI.
3
+
planet-mcp is a local [MCP](https://modelcontextprotocol.io/introduction) server powered by the [Planet SDK](https://github.com/planetlabs/planet-client-python). It allows an AI agent/chat to interact with the Planet API.
5
4
6
5
To get started with your preferred AI agent, find it in the Usage section below.
7
6
8
7
[TOC]
9
8
10
9
## Beta warning
11
10
12
-
**This is experimental software.** This MCP service will invoke the Planet SDK/CLI on your behalf. It can create and modify orders, subscriptions, and more. Do not disable tool approvals. Always carefully review tool prompts before approving them. Use at your own risk.
11
+
**This is experimental software.** This MCP service will invoke the Planet SDK/CLI on your behalf. It can create and modify orders, subscriptions, and more. Do not disable tool approvals and always carefully review tool prompts before approving them. Use at your own risk.
13
12
14
13
Tools may be added, removed or altered based on testing/feedback.
15
14
16
-
It will consume AI tokens.
15
+
Reminder: MCP servers and tools will increase the number of tokens used during interactions with your LLM provider.
17
16
17
+
## Usage
18
18
19
-
## Usage (stdio)
20
-
21
-
#### Prerequisites
19
+
### Prerequisites
22
20
23
21
1. Python
24
22
2. Planet SDK
25
23
26
-
To install the Planet SDK and `planet-mcp` from the Planet internal PyPI run the following commands:
24
+
To install the Planet SDK and MCP server, use `pip` or your preferred package manager:
3. Set up gemini by running `gemini` and following the instructions.
58
-
4. Quit and add the following to your `~/.gemini/settings.json` file:
59
-
60
-
```json
61
-
"mcpServers": {
62
-
"planet": {
63
-
"command": "planet-mcp",
64
-
"description": "Planet MCP Server",
65
-
"timeout": 30000,
66
-
"trust": false
67
-
}
68
-
}
69
-
```
45
+
### Supported AI assistants
70
46
71
-
#### GitHub Copilot
72
-
73
-
To allow GitHub Copilot to read these MCP tools, you need to configure the `mcp.json` file. Here's how:
74
-
75
-
1.**Locate or create the `mcp.json` file:**
76
-
77
-
This file is typically located in here: `/Library/Application Support/Code/User/profiles/-1ccb06ef` If it doesn't exist, you can create it, or create a `.vscode/mcp.json` in your repo.
78
-
79
-
2.**Add the following configuration:**
80
-
81
-
```json
82
-
{
83
-
"servers": {
84
-
"planet": {
85
-
"command": "planet-mcp",
86
-
}
87
-
},
88
-
"inputs": []
89
-
}
90
-
```
47
+
The following AI agents have been tested with the Planet local MCP. For other agents, refer to their documentation for adding a custom MCP server (the Planet local MCP uses `stdio` transport).
91
48
92
49
#### Claude Code
93
50
94
-
To use this MCP server with [Claude Code](https://claude.ai/code), run the following command:
51
+
To connect with [Claude Code](https://claude.ai/code), run the following command:
95
52
96
53
```bash
97
54
claude mcp add planet planet-mcp
98
55
```
99
56
100
-
This will add the planet-mcp server to your Claude Code configuration, allowing you to interact with Planet's API through Claude Code's terminal interface.
57
+
#### Gemini CLI
58
+
59
+
Add the following to your `~/.gemini/settings.json` file:
60
+
61
+
```json
62
+
"mcpServers": {
63
+
"planet": {
64
+
"command": "planet-mcp",
65
+
"description": "Planet MCP Server",
66
+
"timeout": 30000,
67
+
"trust": false
68
+
}
69
+
}
70
+
```
71
+
72
+
#### GitHub Copilot
101
73
74
+
To connect using GitHub Copilot, configure the `mcp.json` file (see [VSCode docs](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server)) with the following configuration:
102
75
76
+
```json
77
+
{
78
+
"servers": {
79
+
"planet": {
80
+
"command": "planet-mcp",
81
+
}
82
+
},
83
+
"inputs": []
84
+
}
85
+
```
103
86
104
87
### Example queries
105
88
@@ -147,4 +130,4 @@ This will add the planet-mcp server to your Claude Code configuration, allowing
0 commit comments