Skip to content

Commit 48ff6f8

Browse files
README updates for local use (#1)
* README updates for local use * remove TOC tag * add troubleshooting section
1 parent d72aecc commit 48ff6f8

File tree

1 file changed

+56
-59
lines changed

1 file changed

+56
-59
lines changed

README.md

Lines changed: 56 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,31 @@
11
# Planet MCP
22

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 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.
54

65
To get started with your preferred AI agent, find it in the Usage section below.
76

8-
[TOC]
9-
107
## Beta warning
118

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.
9+
**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.
1310

1411
Tools may be added, removed or altered based on testing/feedback.
1512

16-
It will consume AI tokens.
17-
13+
Reminder: MCP servers and tools will increase the number of tokens used during interactions with your LLM provider.
1814

19-
## Usage (stdio)
15+
## Usage
2016

21-
#### Prerequisites
17+
### Prerequisites
2218

2319
1. Python
2420
2. Planet SDK
2521

26-
To install the Planet SDK and `planet-mcp` from the Planet internal PyPI run the following commands:
22+
To install the Planet SDK and MCP server, use `pip` or your preferred package manager:
2723

2824
```
29-
pip install planet
30-
pip install --index-url https://pypi.prod.planet-labs.com/simple/ planet-mcp
25+
pip install planet planet-mcp
3126
```
3227

33-
#### Authentication
28+
### Authentication
3429

3530
You must authenticate your Planet account before using the local MCP server. You can do this by running:
3631

@@ -45,69 +40,71 @@ if you have PL_API_KEY set globaly, you should run `unset PL_API_KEY` and then `
4540

4641
---
4742

48-
#### Gemini CLI
49-
50-
1. Install [Gemini](https://github.com/google-gemini/gemini-cli)
51-
2. Set up authentication:
52-
53-
```bash
54-
GOOGLE_CLOUD_PROJECT=your-project-id
55-
GOOGLE_CLOUD_LOCATION=us-central1
56-
```
57-
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-
```
70-
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.
43+
### Supported AI assistants
7844

79-
2. **Add the following configuration:**
80-
81-
```json
82-
{
83-
"servers": {
84-
"planet": {
85-
"command": "planet-mcp",
86-
}
87-
},
88-
"inputs": []
89-
}
90-
```
45+
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).
9146

9247
#### Claude Code
9348

94-
To use this MCP server with [Claude Code](https://claude.ai/code), run the following command:
49+
To connect with [Claude Code](https://claude.ai/code), run the following command:
9550

9651
```bash
9752
claude mcp add planet planet-mcp
9853
```
9954

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.
55+
#### Gemini CLI
56+
57+
Add the following to your `~/.gemini/settings.json` file:
58+
59+
```json
60+
"mcpServers": {
61+
"planet": {
62+
"command": "planet-mcp",
63+
"description": "Planet MCP Server",
64+
"timeout": 30000,
65+
"trust": false
66+
}
67+
}
68+
```
10169

70+
#### GitHub Copilot
10271

72+
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:
73+
74+
```json
75+
{
76+
"servers": {
77+
"planet": {
78+
"command": "planet-mcp"
79+
}
80+
},
81+
"inputs": []
82+
}
83+
```
10384

104-
### Example queries
85+
## Example queries
10586

10687
- Does Planet have any recent imagery over Puget Sound?
10788
- List my subscriptions
10889
- Get my June 2025 subscriptions and cancel the ones with name Netherlands
10990
- Create a PlanetScope subscription with the first item in my Netherlands Feature Collection.
11091

92+
## Troubleshooting
93+
94+
### Unable to launch planet-mcp (ENOENT, No such file or directory, etc.):
95+
96+
This is likely due to the `planet-mcp` package being installed to a different Python environment than the one your AI agent is using. The easiest way to resolve this is to run `which planet-mcp` after installing the package, and then copy the full path to your AI agent's MCP configuration. For example, if `which planet-mcp` returns `/home/user/.local/share/virtualenvs/test/bin/planet-mcp`, your config file would look like:
97+
98+
```json
99+
{
100+
"servers": {
101+
"planet": {
102+
"command": "/home/user/.local/share/virtualenvs/test/bin/planet-mcp"
103+
}
104+
}
105+
}
106+
```
107+
111108

112109
## Local dev
113110

@@ -147,4 +144,4 @@ This will add the planet-mcp server to your Claude Code configuration, allowing
147144
Optional run the inspector with
148145
```bash
149146
uv run fastmcp dev src/planet_mcp/main.py
150-
```
147+
```

0 commit comments

Comments
 (0)