Skip to content

Commit 1dde895

Browse files
Improvement
1 parent df03df5 commit 1dde895

File tree

8 files changed

+68
-569
lines changed

8 files changed

+68
-569
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,5 @@ dist
1313
.env
1414
.envrc
1515
codegen.log
16+
gitpod_mcp.log
1617
Brewfile.lock.json

examples/mcp-server/.gitignore

Lines changed: 0 additions & 47 deletions
This file was deleted.

examples/mcp-server/.python-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

examples/mcp-server/README.md

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Gitpod MCP Server
1+
# Gitpod MCP Server Example
22

33
A Modal Context Protocol (MCP) server that enables Claude Desktop to interact with Gitpod's API. This integration allows Claude to create Gitpod environments, check identity information, and perform other Gitpod-related tasks directly through natural language commands.
44

@@ -14,12 +14,10 @@ A Modal Context Protocol (MCP) server that enables Claude Desktop to interact wi
1414
## 🚀 Available Tools
1515

1616
1. **get-identity**
17-
1817
- Get authenticated identity information from Gitpod
1918
- No additional parameters required
2019

2120
2. **create-environment**
22-
2321
- Create a new Gitpod environment from a repository URL
2422
- Optional parameter: `repository_url` (defaults to https://github.com/gitpod-io/empty)
2523

@@ -28,33 +26,24 @@ A Modal Context Protocol (MCP) server that enables Claude Desktop to interact wi
2826
- Required parameter: `command` (command to run in the environment)
2927
- Optional parameter: `repository_url` (defaults to https://github.com/gitpod-io/empty)
3028

31-
## 📋 Prerequisites
29+
## Prerequisites
3230

33-
- Python 3.11 or higher
31+
- Python 3.8 or higher
3432
- Claude Desktop application
35-
- Gitpod flex account and Personal Access Token
36-
- `uv` package manager (`curl -LsSf https://astral.sh/uv/install.sh | sh`)
37-
38-
## ⚙️ Installation
33+
- Gitpod flex account and API token
3934

40-
1. Clone the repository:
35+
## Installation
4136

37+
1. Clone the repository and install dependencies:
4238
```bash
4339
git clone https://github.com/gitpod-io/gitpod-sdk-python
44-
cd gitpod-sdk-python/examples/mcp-server
45-
```
46-
47-
2. Install dependencies:
48-
49-
```bash
50-
uv sync
40+
cd gitpod-sdk-python
41+
./scripts/bootstrap
5142
```
5243

53-
## 🔑 Configuration
54-
55-
1. Get your Gitpod API token:
44+
## Configuration
5645

57-
- Go to [Gitpod Flex Dashboard](https://app.gitpod.io/settings/personal-access-tokens) → Settings → Personal access tokens
46+
1. Get your Gitpod API token from [Gitpod Flex Dashboard](https://app.gitpod.io/settings/personal-access-tokens)
5847

5948
2. Configure Claude Desktop:
6049
Create or update `~/Library/Application\ Support/Claude/claude_desktop_config.json`:
@@ -63,12 +52,9 @@ uv sync
6352
{
6453
"mcpServers": {
6554
"gitpod-mcp": {
66-
"command": "/path/to/uv",
55+
"command": "python",
6756
"args": [
68-
"--directory",
69-
"/path/to/gitpod-sdk-python/examples/mcp-server",
70-
"run",
71-
"server.py"
57+
"/path/to/gitpod-sdk-python/examples/mcp-server/server.py"
7258
],
7359
"env": {
7460
"GITPOD_LOG": "info",
@@ -81,16 +67,14 @@ uv sync
8167

8268
## 🎯 Usage Examples
8369

84-
Here are some ways you can interact with the MCP server through Claude:
70+
Here are some ways you can interact with the MCP server through Claude Desktop:
8571

8672
1. Check your Gitpod identity:
87-
8873
```
8974
"Get my Gitpod identity"
9075
```
9176

9277
2. Create a new environment:
93-
9478
```
9579
"Create a Gitpod environment"
9680
"Create a Gitpod environment for https://github.com/my/repo"
@@ -107,13 +91,11 @@ Here are some ways you can interact with the MCP server through Claude:
10791
The server logs all activities to `gitpod_mcp.log` in the project directory. Common issues:
10892

10993
1. **Authentication Errors**
110-
11194
- Verify your Gitpod API token is valid
11295
- Check if the token has the required scopes
11396
- Look for authentication errors in the log
11497

11598
2. **Environment Creation Issues**
116-
11799
- Ensure the repository URL is accessible
118100
- Check if you have an environment class available
119101
- Verify your Gitpod account has available resources

examples/mcp-server/pyproject.toml

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)