Skip to content

Commit 29a2538

Browse files
committed
updating readme and agents
1 parent a376447 commit 29a2538

2 files changed

Lines changed: 60 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# AGENTS.md
2+
3+
Guidelines for AI agents working in this repo.
4+
5+
## Repo purpose
6+
7+
This repo packages the [Braintrust MCP server](https://www.braintrust.dev/docs/integrations/developer-tools/mcp) as a [Codex marketplace plugin](https://developers.openai.com/codex/plugins). The key files are:
8+
9+
- `.codex-plugin/plugin.json` — plugin manifest (version, UI metadata, default prompts)
10+
- `.mcp.json` — MCP server definition
11+
- `skills/braintrust/` — agent skills exposed through the plugin
12+
13+
## Making changes
14+
15+
- **Skills**: There is only one simple skill in this repo which handles routing and tool definitions, it should not be modified significantly.
16+
- **MCP config**: edit `.mcp.json` to change the MCP server command or environment variables.
17+
- **Plugin metadata**: edit `.codex-plugin/plugin.json` for display name, description, brand color, default prompts, etc.
18+
19+
## Releasing a new version
20+
21+
1. Bump `"version"` in `.codex-plugin/plugin.json`.
22+
2. Commit, tag, and create a GitHub release (see README for exact commands).
23+
3. Do **not** skip the git tag — releases are tracked via tags so users can see a changelog.

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,41 @@
1-
## MCP Wrapper for Codex Marketplace
1+
# Braintrust Codex Plugin
22

3-
To add locally, follow instructions [here](https://developers.openai.com/codex/plugins/build#install-a-local-plugin-manually). Sample PR with setup: https://github.com/braintrustdata/braintrust/pull/13536
3+
A [Codex plugin](https://developers.openai.com/codex/plugins) that connects the Braintrust MCP server to the Codex marketplace, enabling agents to query Braintrust evals, logs, experiments, datasets, prompts, and traces.
4+
5+
## Local setup
6+
7+
Follow the [Codex plugin local install guide](https://developers.openai.com/codex/plugins/build#install-a-local-plugin-manually) to sideload this plugin.
8+
9+
A reference PR showing a working local setup: https://github.com/braintrustdata/braintrust/pull/13536
10+
11+
Once installed it should look like this:
412

5-
Should appear like this:
613
<img width="1067" height="1229" alt="image" src="https://github.com/user-attachments/assets/b9acaa81-3f95-4164-b65e-17355fc69f5b" />
714

15+
## Contributing
16+
17+
When adding or modifying a skill, update the skill files under `skills/braintrust/` and test locally before opening a PR.
18+
19+
## Releasing
20+
21+
1. Bump the version in `.codex-plugin/plugin.json`:
22+
```json
23+
{ "version": "0.2.0" }
24+
```
25+
26+
2. Commit the version bump:
27+
```bash
28+
git add .codex-plugin/plugin.json
29+
git commit -m "chore: bump version to 0.2.0"
30+
```
31+
32+
3. Create a git tag and GitHub release:
33+
```bash
34+
git tag v0.2.0
35+
git push origin main --tags
36+
gh release create v0.2.0 --title "v0.2.0" --notes "Describe what changed"
37+
```
38+
39+
Users can see the changelog via [GitHub Releases](https://github.com/braintrustdata/braintrust-codex-plugin/releases).
40+
41+
To make the repo public, ping **#wg-infra** or **#eng** on Slack.

0 commit comments

Comments
 (0)