Skip to content

Commit 7a577a2

Browse files
stephenhillierangaither
authored andcommitted
README updates for local use
1 parent d4168b3 commit 7a577a2

File tree

1 file changed

+39
-56
lines changed

1 file changed

+39
-56
lines changed

README.md

Lines changed: 39 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,33 @@
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

87
[TOC]
98

109
## Beta warning
1110

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

1413
Tools may be added, removed or altered based on testing/feedback.
1514

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

17+
## Usage
1818

19-
## Usage (stdio)
20-
21-
#### Prerequisites
19+
### Prerequisites
2220

2321
1. Python
2422
2. Planet SDK
2523

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:
2725

2826
```
29-
pip install planet
30-
pip install --index-url https://pypi.prod.planet-labs.com/simple/ planet-mcp
27+
pip install planet planet-mcp
3128
```
3229

33-
#### Authentication
30+
### Authentication
3431

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

@@ -45,61 +42,47 @@ if you have PL_API_KEY set globaly, you should run `unset PL_API_KEY` and then `
4542

4643
---
4744

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-
```
45+
### Supported AI assistants
7046

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).
9148

9249
#### Claude Code
9350

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:
9552

9653
```bash
9754
claude mcp add planet planet-mcp
9855
```
9956

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
10173

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:
10275

76+
```json
77+
{
78+
"servers": {
79+
"planet": {
80+
"command": "planet-mcp",
81+
}
82+
},
83+
"inputs": []
84+
}
85+
```
10386

10487
### Example queries
10588

@@ -147,4 +130,4 @@ This will add the planet-mcp server to your Claude Code configuration, allowing
147130
Optional run the inspector with
148131
```bash
149132
uv run fastmcp dev src/planet_mcp/main.py
150-
```
133+
```

0 commit comments

Comments
 (0)