Skip to content

Commit 660a202

Browse files
naman485naman485
authored
Merge pull request #9 from NodeOps-app/docs/readme-v2
docs: comprehensive README with all 9 IDE integrations + glama.json
2 parents 62e75db + 77d868a commit 660a202

15 files changed

Lines changed: 1585 additions & 16 deletions

‎Integrations/Integration-Antigravity.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Antigravity
3+
order: 10
4+
---
5+
# CreateOS MCP Integration with Antigravity
6+
7+
## Overview
8+
9+
Integrate CreateOS with Antigravity using the MCP (Model Context Protocol) to enable AI-powered deployment workflows directly from the Antigravity agent interface.
10+
11+
## Prerequisites
12+
13+
- Antigravity application installed
14+
- CreateOS account with API key access
15+
16+
## Setup Instructions
17+
18+
### Step 1: Access MCP Server Settings
19+
20+
1. Open the **Agent chat window** in Antigravity
21+
2. Click on the **"…"** menu in the top right corner
22+
3. Select **MCP Servers** from the dropdown list
23+
24+
![Antigravity1](https://ik.imagekit.io/nodeops/Docs%20Images/Antigravity/1.png?updatedAt=1769668524785)
25+
26+
### Step 2: Open Configuration File
27+
28+
1. Click on **"Manage MCP Servers"**
29+
30+
![Antigravity2](https://ik.imagekit.io/nodeops/Docs%20Images/Antigravity/2.png?updatedAt=1769668524890)
31+
32+
2. In the menu that opens, click **"View raw config"**
33+
34+
![Antigravity3](https://ik.imagekit.io/nodeops/Docs%20Images/Antigravity/3.png?updatedAt=1769668524710)
35+
36+
3. This will open the `mcp_config.json` file
37+
38+
### Step 3: Configure CreateOS MCP
39+
40+
Paste the following configuration into `mcp_config.json`, replacing `CREATEOS_API_KEY` with your actual API key:
41+
42+
```json
43+
{
44+
"mcpServers": {
45+
"createos": {
46+
"serverUrl": "https://api-createos.nodeops.network/mcp",
47+
"headers": {
48+
"X-Api-Key": "CREATEOS_API_KEY"
49+
}
50+
}
51+
},
52+
"inputs": []
53+
}
54+
```
55+
56+
**Getting Your API Key:**
57+
58+
1. Log in to CreateOS
59+
2. Navigate to **Profile Settings**
60+
3. Copy your API key from the **API Key** section
61+
62+
<br/>
63+
64+
<a href="https://ik.imagekit.io/nodeops/No%20Sound/API%20Key%20Retrieval.mp4" target="_blank">Watch Tutorial →</a>
65+
66+
<MDXVideo
67+
src="https://ik.imagekit.io/nodeops/No%20Sound/API%20Key%20Retrieval.mp4"
68+
caption="API key retrieval tutorial"
69+
/>
70+
71+
**Security Note**: Keep your API key confidential and never share it publicly.
72+
73+
### Step 4: Apply Configuration
74+
75+
1. Save the `mcp_config.json` file
76+
2. Restart the Antigravity application completely
77+
78+
## Verification
79+
80+
After restarting, Antigravity will automatically connect to the CreateOS MCP server. You can verify the connection by asking the agent to list your CreateOS projects or perform a deployment action.
81+
82+
## Usage
83+
84+
Once configured, simply tell the Antigravity agent what you want to deploy through CreateOS, and it will handle the integration automatically.

‎Integrations/Integration-ChatGPT.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: ChatGPT
3+
order: 3
4+
---
5+
6+
# ChatGPT Integration Guide
7+
8+
## Overview
9+
10+
Integrate CreateOS with ChatGPT using the MCP (Model Context Protocol) to enable AI-powered deployment workflows directly from the ChatGPT web interface.
11+
12+
## Prerequisites
13+
14+
- ChatGPT account at <a href="https://chatgpt.com" target="_blank">chatgpt.com</a>
15+
- CreateOS account
16+
17+
## Setup Instructions
18+
19+
### Step 1: Access ChatGPT Settings
20+
21+
1. Log in to your ChatGPT account at <a href="https://chatgpt.com" target="_blank">chatgpt.com</a>
22+
2. Click on your profile icon in the bottom left corner
23+
3. Select **<a href="https://chatgpt.com/#settings" target="_blank">Settings</a>** from the list
24+
25+
### Step 2: Enable Developer Mode
26+
27+
1. Navigate to **Apps → <a href="https://chatgpt.com/#settings/Connectors/Advanced" target="_blank">Advanced Settings</a>**
28+
![ChatGPT1](https://ik.imagekit.io/nodeops/Docs%20Images/ChatGPT/1.png?updatedAt=1769668492756)
29+
2. Toggle on **Developer Mode**
30+
![ChatGPT2](https://ik.imagekit.io/nodeops/Docs%20Images/ChatGPT/2.png?updatedAt=1769668492727)
31+
32+
33+
### Step 3: Create New App with MCP Configuration
34+
35+
1. Click the **Create app** button (located above the enabled option)
36+
2. Fill in the app details:
37+
- **Name:** CreateOS (or your preferred name)
38+
- **Description:** CreateOS deployment service (as you wish)
39+
3. Add the following MCP URL: `https://api-createos.nodeops.network/mcp`
40+
4. Set **Authentication** to: **OAuth**
41+
5. Click **Create**
42+
43+
![ChatGPT3](https://ik.imagekit.io/nodeops/Docs%20Images/ChatGPT/3.png?updatedAt=1769668492719)
44+
45+
6. Log in using your CreateOS account when prompted
46+
47+
---
48+
49+
**You're all set!** Your ChatGPT instance is now connected to CreateOS via MCP.
50+

‎Integrations/Integration-Claude-Code.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
title: Claude Code
3+
order: 1
4+
---
5+
6+
# Claude Code Integration Guide
7+
8+
## Overview
9+
10+
Integrate CreateOS with Claude Code using the MCP (Model Context Protocol) to enable AI-powered deployment workflows directly from your command line.
11+
12+
---
13+
14+
## Prerequisites
15+
16+
- Claude Code installed
17+
- CreateOS account with API key access
18+
- Command line access (PowerShell, Terminal, or Command Prompt)
19+
20+
---
21+
22+
## Setup Instructions
23+
24+
### Step 1: Verify Claude Code Installation
25+
26+
1. Open your terminal or command prompt
27+
2. Run the following command to check if Claude Code is installed:
28+
```powershell
29+
claude --version
30+
```
31+
32+
If not installed, install Claude Code according to its <a href="https://code.claude.com/docs/en/mcp" target="_blank">official installation instructions</a>.
33+
34+
### Step 2: Authenticate Claude Code
35+
36+
1. Log in to Claude Code by running:
37+
```powershell
38+
claude auth login
39+
```
40+
41+
2. Verify login:
42+
```powershell
43+
claude auth status
44+
```
45+
46+
Ensure you're successfully authenticated before proceeding.
47+
48+
### Step 3: Configure CreateOS MCP Connection
49+
50+
Run the following command, replacing `"CREATEOS_API_KEY"` with your actual CreateOS API key:
51+
```powershell
52+
claude mcp add createos-mcp --transport http https://api-createos.nodeops.network/mcp --header "X-API-Key: CREATEOS_API_KEY"
53+
```
54+
55+
**Getting Your API Key:**
56+
57+
1. Log in to CreateOS
58+
2. Navigate to **Profile Settings**
59+
3. Copy your API key from the **API Key** section
60+
61+
<br/>
62+
63+
<a href="https://ik.imagekit.io/nodeops/No%20Sound/API%20Key%20Retrieval.mp4" target="_blank">Watch Tutorial →</a>
64+
65+
<MDXVideo
66+
src="https://ik.imagekit.io/nodeops/No%20Sound/API%20Key%20Retrieval.mp4"
67+
caption="API key retrieval tutorial"
68+
/>
69+
70+
**Security Note**: Keep your API key confidential and never share it publicly.
71+
72+
### Step 4: Apply Configuration
73+
74+
1. After adding the MCP server, restart Claude Code
75+
2. Close any active Claude sessions and reopen
76+
77+
### Step 5: Verify Connection
78+
79+
Run the following command to verify the MCP connection:
80+
```powershell
81+
claude mcp list
82+
```
83+
84+
**In Claude Desktop**, if you've already initiated the `claude` command, use:
85+
```
86+
/mcp
87+
```
88+
89+
**Expected Output:**
90+
```
91+
✓ createos-mcp connected
92+
```
93+
94+
---
95+
96+
## Demo Video
97+
98+
Vibecode and deploy through CreateOS MCP: **<a href="https://ik.imagekit.io/nodeops/No%20Sound/Claude%20Code%20MCP%20Demo.mp4" target="_blank">Demo</a>**
99+
<MDXVideo
100+
src="https://ik.imagekit.io/nodeops/No%20Sound/Claude%20Code%20MCP%20Demo.mp4"
101+
caption="Claude Code Vibecode Demo"
102+
/>
103+
---
104+
105+
## Troubleshooting
106+
107+
If the connection fails, confirm:
108+
109+
- Claude Code is properly installed and authenticated
110+
- API key is valid and has proper permissions
111+
- Command syntax is correct (no extra spaces or characters)
112+
- Claude Code has been fully restarted after adding the MCP server
113+
114+
---
115+
116+
## Next Steps
117+
118+
Once connected, you can:
119+
120+
- Use AI prompts to deploy services directly from the command line
121+
- Access CreateOS infrastructure through Claude Code
122+
- Manage deployments with natural language commands

‎Integrations/Integration-Claude-ai.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Claude.ai or Desktop
3+
order: 2
4+
---
5+
6+
# Claude.ai or Claude Desktop Integration Guide
7+
8+
## Overview
9+
10+
Integrate CreateOS with Claude.ai using the MCP (Model Context Protocol) to enable AI-powered deployment workflows directly from the Claude.ai web interface.
11+
12+
## Prerequisites
13+
14+
- Claude account at <a href="https://claude.ai" target="_blank">claude.ai</a>
15+
- Claude Pro, Max, or any subscription
16+
- CreateOS account
17+
18+
## Setup Instructions
19+
20+
### Step 1: Access Claude Settings
21+
22+
1. Log in to your <a href="https://claude.ai" target="_blank">Claude.ai</a> account
23+
2. Click on your profile icon in the bottom left corner
24+
3. Select **Settings** from the dropdown menu
25+
26+
### Step 2: Connectors
27+
28+
1. Navigate to **<a href="https://claude.ai/settings/connectors" target="_blank">Connectors</a>**
29+
30+
![Claude.ai1](https://ik.imagekit.io/nodeops/Docs%20Images/Claude.ai/1.png?updatedAt=1769668492798)
31+
32+
2. Click on **<a href="https://claude.ai/settings/connectors?modal=add-custom-connector" target="_blank">"Add a custom connector"</a>**
33+
34+
![Claude.ai2](https://ik.imagekit.io/nodeops/Docs%20Images/Claude.ai/2.png?updatedAt=1769668492790)
35+
36+
### Step 3: Configure
37+
38+
1. Fill in the app details:
39+
- **Name:** CreateOS (or your preferred name)
40+
- **MCP URL:** `https://api-createos.nodeops.network/mcp`
41+
42+
![Claude.ai3](https://ik.imagekit.io/nodeops/Docs%20Images/Claude.ai/3.png?updatedAt=1769668492768)
43+
44+
2. Click **Add**
45+
3. Click on **Connect** for CreateOS
46+
47+
![Claude.ai4](https://ik.imagekit.io/nodeops/Docs%20Images/Claude.ai/4.png?updatedAt=1769668492769)
48+
49+
4. Log in with your CreateOS credentials when prompted
50+
51+
---
52+
53+
**You're all set!** Your Claude.ai instance is now connected to CreateOS via MCP.

0 commit comments

Comments
 (0)