@polygraph/codex-plugin 0.4.21 → 0.4.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -32,7 +32,7 @@ Polygraph functionality is available via both MCP tools and CLI commands. Use wh
|
|
|
32
32
|
| `spawn_agent` | — | Start a new child task or send an explicit follow-up to an active task in another repository. Input: `{ sessionId, repo, instruction, context?, taskId? }`. Output: `{ taskId, message, status: 'delegated' }`. Pass the `taskId` returned by a prior call to route a follow-up message to a specific active task; omit to start a new child run. A session resume or reconstruction is read-only context restoration; after resuming, do not use `spawn_agent` to continue changes unless the user explicitly asks for changes. |
|
|
33
33
|
| `show_agent` | — | Poll flat per-child status for the session. Output: `{ children: PolygraphChildStatusItem[] }` where each item exposes `repositoryId`, `repoFullName`, `status`, `lastOutputLines`, `durationMs`, `instruction`, `agentType?`, `inputRequiredQuestion?`. `status` is an AcpRunStatus: `'created' \| 'in-progress' \| 'input-required' \| 'completed' \| 'failed' \| 'cancelled'` (British double-L on `'cancelled'`). `inputRequiredQuestion` is populated only when `status === 'input-required'`. |
|
|
34
34
|
| `stop_agent` | — | Cancel an in-progress child. Output: `{ taskId, state: 'cancelled', sessionPreserved: true, output, message }`. Because `sessionPreserved: true`, the preserved agent session can be restored later for context, but resume must wait for explicit user instructions before making changes. |
|
|
35
|
-
| `push_branch` | — | Push a local git branch to the remote repository |
|
|
35
|
+
| `push_branch` | — | Push a local git branch to the remote repository. Requires a session description. |
|
|
36
36
|
| `create_pr` | — | Create draft PRs with session metadata linking related PRs |
|
|
37
37
|
| `show_session` | `polygraph session show <id> [--details]` | Query status of the current session. Use details when session summary, repo IDs, PR URLs, and PR descriptions are needed. |
|
|
38
38
|
| `update_session_description` | `polygraph session update-description` | Set the current session description from a synthesized progress summary or user-provided text. This updates session metadata only; it does not require PR creation or mark-ready. |
|
|
@@ -75,9 +75,9 @@ After logging in (or if logged in but no org is selected), use `polygraph accoun
|
|
|
75
75
|
|
|
76
76
|
4. **Monitor child agents** - Use `show_agent` to poll progress and read the flat `children[]` array for each child's `status` and `lastOutputLines`.
|
|
77
77
|
5. **Stop child agents** (if needed) - Use `stop_agent` to cancel an in-progress child agent. The underlying agent session is preserved for later read-only context restoration; after a resume, wait for explicit user instructions before making changes.
|
|
78
|
-
6. **Push branches** - Use `push_branch` after making commits.
|
|
79
|
-
7. **Update session description**
|
|
80
|
-
8. **Create draft PRs** - Use `create_pr` to create linked draft PRs.
|
|
78
|
+
6. **Push branches** - Use `push_branch` after making commits. A required `description` must follow the Session Description Policy.
|
|
79
|
+
7. **Update session description** - Use `update_session_description` to update the session description; must follow the Session Description Policy. Independent of PR creation or mark-ready.
|
|
80
|
+
8. **Create draft PRs** - Use `create_pr` to create linked draft PRs. Always pass `description` following the Session Description Policy.
|
|
81
81
|
9. **Associate existing PRs** (optional) - Use `associate_pr` to link PRs created outside Polygraph.
|
|
82
82
|
10. **Query PR status** - Use `show_session` to check progress.
|
|
83
83
|
11. **Mark PRs ready** - Use `mark_pr_ready` when work is complete.
|
|
@@ -287,6 +287,7 @@ Once work is complete in a repository, push the branch using `push_branch`. This
|
|
|
287
287
|
- `sessionId` (required): The Polygraph session ID
|
|
288
288
|
- `repo` (required): Repository name or repository ID to push from
|
|
289
289
|
- `branch` (required): Branch name to push to remote
|
|
290
|
+
- `description` (required): A session description is required. Must follow the Session Description Policy.
|
|
290
291
|
|
|
291
292
|
```
|
|
292
293
|
push_branch(
|
|
@@ -300,9 +301,7 @@ push_branch(
|
|
|
300
301
|
|
|
301
302
|
`description` is user-facing Polygraph session context.
|
|
302
303
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
If you pass `description`, use the canonical structured format:
|
|
304
|
+
`description` is required for `push_branch`, `create_pr`, `associate_pr`, and `update_session_description`. (`mark_pr_ready` does not take a description.) Use the canonical structured format:
|
|
306
305
|
|
|
307
306
|
```text
|
|
308
307
|
Goal: <what the session is trying to accomplish>
|
|
@@ -336,7 +335,7 @@ Create PRs for all repositories at once using `create_pr`. PRs are created as dr
|
|
|
336
335
|
- `body` (required): PR description (session metadata is appended automatically)
|
|
337
336
|
- `branch` (required): Branch name that was pushed
|
|
338
337
|
- `targetRepository` (optional): Target GitHub repository for fork PR creation or registration, as `owner/repo`. Omit for same-repository PRs.
|
|
339
|
-
- `description` (
|
|
338
|
+
- `description` (required): Must follow the Session Description Policy.
|
|
340
339
|
|
|
341
340
|
**PR title format (applies to parent and child agents):**
|
|
342
341
|
|
|
@@ -522,7 +521,7 @@ Provide either a `prUrl` to associate a specific PR, or a `branch` name plus `re
|
|
|
522
521
|
- `prUrl` (optional): URL of an existing pull request to associate
|
|
523
522
|
- `branch` (optional): Branch name to find and associate PRs for
|
|
524
523
|
- `repo` (optional): Source repository for branch-based association. Required when using `branch` in a multi-repo session.
|
|
525
|
-
- `description` (
|
|
524
|
+
- `description` (required): Must follow the Session Description Policy.
|
|
526
525
|
|
|
527
526
|
```
|
|
528
527
|
associate_pr(
|
|
@@ -679,6 +678,7 @@ If the session has a description timeline, also display:
|
|
|
679
678
|
1. **Poll child status before proceeding** — Always verify child agents have reached a terminal `child.status` (`'completed'`, `'failed'`, or `'cancelled'`) via `show_agent` before pushing branches or creating PRs
|
|
680
679
|
1. **Link PRs in descriptions** - Reference related PRs in each PR body
|
|
681
680
|
1. **Keep PRs as drafts** until all repos are ready
|
|
681
|
+
1. **Always pass `description`** when calling `create_pr`, `associate_pr`, or `update_session_description` — it is required and must follow the Session Description Policy
|
|
682
682
|
1. **Test integration** before marking PRs ready
|
|
683
683
|
1. **Coordinate merge order** if there are deployment dependencies
|
|
684
684
|
|