Skip to content

Commit 5bd9282

Browse files
committed
Update README and plugin configuration for clarity and improved user guidance; enhance installation instructions and descriptions for Render plugin features.
1 parent 1259052 commit 5bd9282

File tree

3 files changed

+88
-68
lines changed

3 files changed

+88
-68
lines changed

.codex-plugin/plugin.json

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
"name": "render",
33
"version": "0.1.0",
4-
"description": "Deploy, debug, monitor, and troubleshoot Render services from Codex. Works with the Render CLI, with optional MCP for advanced workflows.",
4+
"description": "Build, deploy, and troubleshoot apps on Render from Codex.",
55
"author": {
66
"name": "Render",
77
"email": "support@render.com",
88
"url": "https://render.com"
99
},
10-
"homepage": "https://render.com",
11-
"repository": "https://github.com/render-oss/skills",
10+
"homepage": "https://github.com/renderinc/render-codex-plugin",
11+
"repository": "https://github.com/renderinc/render-codex-plugin",
1212
"license": "MIT",
1313
"keywords": [
1414
"render",
@@ -23,20 +23,22 @@
2323
"mcpServers": "./.mcp.json",
2424
"interface": {
2525
"displayName": "Render",
26-
"shortDescription": "Deploy, debug, and monitor Render services with the Render CLI. Add MCP later for advanced workflows.",
27-
"longDescription": "Deploy, debug, and monitor Render services from Codex with bundled Render skills. Start with the Render CLI for Blueprint generation, validation, logs, and troubleshooting. Add the bundled MCP server later if you want direct creation, richer monitoring, and structured queries.",
26+
"shortDescription": "Build, deploy, and troubleshoot apps on Render.",
27+
"longDescription": "Use Render in Codex to deploy apps, validate infrastructure, debug failures, monitor services, and work through common platform workflows.",
2828
"developerName": "Render",
2929
"category": "Developer Tools",
3030
"capabilities": [
3131
"Interactive",
3232
"Write"
3333
],
3434
"websiteURL": "https://render.com/",
35+
"privacyPolicyURL": "https://render.com/privacy",
36+
"termsOfServiceURL": "https://render.com/terms",
3537
"brandColor": "#8a05ff",
3638
"defaultPrompt": [
37-
"Help me install and authenticate the Render CLI for Render.",
38-
"Debug my Render deployment with the Render CLI.",
39-
"Help me deploy this project to Render."
39+
"Help me deploy this project to Render.",
40+
"Help me validate my render.yaml for Render.",
41+
"Debug a failed Render deployment."
4042
],
4143
"logo": "./assets/logo.svg"
4244
}

.github/workflows/sync-skills.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,22 @@ jobs:
2222
GIT_TERMINAL_PROMPT: "0"
2323

2424
- name: Create pull request
25+
id: cpr
2526
uses: peter-evans/create-pull-request@v7
2627
with:
2728
commit-message: "Sync skills from render-oss/skills"
2829
title: "Sync skills from render-oss/skills"
2930
body: |
30-
Automated sync of skill files from [render-oss/skills](https://github.com/render-oss/skills).
31+
Automated update of bundled skills from [render-oss/skills](https://github.com/render-oss/skills).
3132
32-
This PR was created by the `sync-skills` workflow. Review the changes and merge when ready.
33+
Review the synced skill changes before merging.
3334
branch: sync-skills
3435
labels: skills-sync
3536
delete-branch: true
37+
38+
- name: Enable auto-merge
39+
if: steps.cpr.outputs.pull-request-operation == 'created' || steps.cpr.outputs.pull-request-operation == 'updated'
40+
uses: peter-evans/enable-pull-request-automerge@v3
41+
with:
42+
pull-request-number: ${{ steps.cpr.outputs.pull-request-number }}
43+
merge-method: squash

README.md

Lines changed: 68 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,119 @@
11
# Render Codex Plugin
22

3-
Deploy, debug, monitor, and troubleshoot applications on [Render](https://render.com) from Codex. Start with the Render CLI for the core workflows. Add MCP later for advanced workflows.
3+
Use Render from Codex to deploy apps, validate `render.yaml`, debug failed deploys, monitor services, and work through common platform workflows.
44

5-
## What it includes
5+
## What you get
66

7-
- `skills/`: Render skills derived from [render-oss/skills](https://github.com/render-oss/skills)
8-
- `scripts/validate-render-yaml.sh`: hook script that runs `render blueprints validate`
9-
- `scripts/sync-skills.sh`: manual skill sync script
10-
- `.mcp.json`: Render MCP server configuration using `RENDER_API_KEY`
11-
- `.codex-plugin/plugin.json`: Codex plugin manifest
12-
- `.github/workflows/sync-skills.yml`: daily skill sync workflow
13-
- `assets/logo.svg`: plugin logo
7+
- Bundled Render skills for deployment, debugging, monitoring, migrations, and workflows
8+
- A bundled `.mcp.json` file for the hosted Render MCP server
9+
- A helper script at `scripts/validate-render-yaml.sh` for `render blueprints validate`
10+
- Plugin metadata and assets for Codex installation
1411

15-
## Reused from the Cursor plugin
12+
## Install the plugin locally
1613

17-
This repository intentionally reuses content from the existing local Cursor Render plugin where the formats align cleanly:
14+
1. Copy the plugin into `~/.codex/plugins/render`:
1815

19-
- skills
20-
- MCP configuration
21-
- validation script
22-
- logo asset
16+
```bash
17+
mkdir -p ~/.codex/plugins
18+
rsync -a ./ ~/.codex/plugins/render/
19+
```
2320

24-
Cursor-specific concepts such as Cursor commands, rules, and agents are not included here because they do not map directly to Codex plugin packaging.
21+
2. Add the plugin to `~/.agents/plugins/marketplace.json`.
22+
23+
If the file already exists, add the `render` entry to the existing `plugins` array.
24+
25+
```json
26+
{
27+
"name": "local-plugins",
28+
"interface": {
29+
"displayName": "Local Plugins"
30+
},
31+
"plugins": [
32+
{
33+
"name": "render",
34+
"source": {
35+
"source": "local",
36+
"path": "./.codex/plugins/render"
37+
},
38+
"policy": {
39+
"installation": "AVAILABLE",
40+
"authentication": "ON_INSTALL"
41+
},
42+
"category": "Developer Tools"
43+
}
44+
]
45+
}
46+
```
2547

26-
## Use it locally in Codex
48+
3. Restart Codex.
49+
4. Open the plugin directory in Codex and install `Render` from your marketplace.
2750

28-
This repository is the source of truth for the plugin. For local Codex use, install the plugin into the standard local plugin path at `~/plugins/render` and register it in `~/.agents/plugins/marketplace.json`.
51+
## Get started
2952

30-
To refresh the local plugin after you edit this repository, run:
53+
Use the plugin to:
3154

32-
```bash
33-
rsync -a ./ ~/plugins/render/
34-
```
55+
- Deploy a project to Render
56+
- Validate and troubleshoot `render.yaml`
57+
- Debug failed deploys and check service status
58+
- Work through common setup and migration tasks
3559

36-
## Get started with the Render CLI
60+
Good first prompts:
61+
62+
- `Help me deploy this project to Render.`
63+
- `Help me validate my render.yaml for Render.`
64+
- `Debug a failed Render deployment.`
3765

38-
The plugin is useful without MCP. Start with the Render CLI for Blueprint generation, `render.yaml` validation, workflow setup, logs, deploy status, and CLI-guided troubleshooting.
66+
## Set up the Render CLI
67+
68+
Many Render workflows depend on the Render CLI.
3969

4070
1. Install the Render CLI:
4171

4272
```bash
4373
brew install render
4474
```
4575

46-
2. Authenticate the CLI:
76+
2. Authenticate:
4777

4878
```bash
4979
render login
5080
```
5181

52-
3. Verify the CLI is ready:
82+
3. Verify access:
5383

5484
```bash
5585
render whoami -o json
5686
```
5787

58-
If `render whoami -o json` fails, do not assume the CLI is usable yet. Fix authentication first.
59-
60-
If you previously set `RENDER_API_KEY` in your shell profile, make sure it is a real key or unset it. A placeholder value can break CLI auth in misleading ways.
88+
If `render whoami -o json` fails, fix authentication before you rely on Render workflows in Codex.
6189

62-
4. Start using the plugin from Codex.
90+
## Use the optional MCP server
6391

64-
Good first prompts:
65-
66-
- `Help me install and authenticate the Render CLI for Render.`
67-
- `Validate my render.yaml for Render.`
68-
- `Debug my Render deployment with the Render CLI.`
69-
70-
## Add MCP for advanced workflows
71-
72-
The bundled MCP server is optional. Add it if you want direct service creation, structured service enumeration, richer monitoring, or structured database queries.
73-
74-
The plugin does not provide an API key input in the Codex plugin UI. Codex reads the bearer token for the bundled MCP server from the environment that launches Codex.
92+
The plugin bundles `.mcp.json` for the hosted Render MCP server. To use it, set `RENDER_API_KEY` before you start Codex.
7593

76-
To enable MCP:
77-
78-
1. Create a Render API key in the [Render Dashboard](https://dashboard.render.com/u/*/settings#api-keys).
79-
2. Quit Codex if it is already open.
80-
3. Launch Codex from Terminal with the key set:
94+
1. Create a Render API key in the [Render Dashboard](https://dashboard.render.com/).
95+
2. Open Account settings > API Keys.
96+
3. Start Codex from Terminal with the key set:
8197

8298
```bash
8399
export RENDER_API_KEY="rnd_..."
84100
open -a Codex
85101
```
86102

87-
4. Keep using that Terminal-launched Codex session. If you reopen Codex later from the Dock or Spotlight, it might not inherit `RENDER_API_KEY`.
88-
5. If you want this to persist for future launches, add the export line to your shell profile such as `~/.zshrc`, then launch Codex from a new Terminal session.
89-
90-
Never save a placeholder like `your_render_api_key` as the value of `RENDER_API_KEY`. A bad value is worse than an unset variable because it can make auth failures look unrelated.
103+
4. Keep using that Terminal-launched session. If you start Codex from the Dock or Spotlight, it might not inherit `RENDER_API_KEY`.
104+
5. If you want the variable to persist, add it to your shell profile such as `~/.zshrc`, then start a new Terminal session.
91105

92-
The bundled MCP server is configured in `.mcp.json` and reads `RENDER_API_KEY` through `bearer_token_env_var`.
106+
Never set `RENDER_API_KEY` to a placeholder value such as `your_render_api_key`. Use a real key or leave the variable unset.
93107

94-
## Keep skills up to date
108+
## For maintainers
95109

96-
Run the manual sync script to refresh `skills/` from [render-oss/skills](https://github.com/render-oss/skills):
110+
Run the sync script to refresh `skills/` from [render-oss/skills](https://github.com/render-oss/skills):
97111

98112
```bash
99113
./scripts/sync-skills.sh
100114
```
101115

102-
GitHub Actions also runs `.github/workflows/sync-skills.yml` every day and opens a pull request when upstream skills change.
103-
104-
## Publish it
105-
106-
Push this repository to GitHub and publish it as the plugin source repository. The plugin payload lives at the repository root, not under a nested `plugins/` directory.
116+
GitHub Actions also runs `.github/workflows/sync-skills.yml` each day and opens a pull request when upstream skills change.
107117

108118
## License
109119

0 commit comments

Comments
 (0)