@tickernelz/paperclip-pro-adapter-codex-local 2026.925.0 → 2026.925.2
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/dist/server/codex-home.d.ts +1 -0
- package/dist/server/codex-home.d.ts.map +1 -1
- package/dist/server/codex-home.js +8 -1
- package/dist/server/codex-home.js.map +1 -1
- package/dist/server/config-schema.d.ts.map +1 -1
- package/dist/server/config-schema.js +17 -0
- package/dist/server/config-schema.js.map +1 -1
- package/dist/server/execute.d.ts.map +1 -1
- package/dist/server/execute.js +21 -3
- package/dist/server/execute.js.map +1 -1
- package/dist/server/execute.paperclip-mcp.test.d.ts +2 -0
- package/dist/server/execute.paperclip-mcp.test.d.ts.map +1 -0
- package/dist/server/execute.paperclip-mcp.test.js +84 -0
- package/dist/server/execute.paperclip-mcp.test.js.map +1 -0
- package/package.json +3 -3
- package/skills/paperclip/SKILL.md +123 -134
- package/skills/paperclip/references/api-reference.md +339 -376
- package/skills/paperclip/references/artifacts.md +54 -57
- package/skills/paperclip/references/cases.md +57 -68
- package/skills/paperclip/references/company-skills.md +66 -146
- package/skills/paperclip/references/issue-workspaces.md +28 -43
- package/skills/paperclip/references/routines.md +52 -44
- package/skills/paperclip/references/workflows.md +32 -46
- package/skills/paperclip-board/SKILL.md +141 -334
- package/skills/paperclip-create-agent/SKILL.md +45 -62
- package/skills/paperclip-create-agent/references/api-reference.md +30 -31
|
@@ -29,38 +29,36 @@ configuration, instruction-template, icon, and `agent-hires` endpoints used belo
|
|
|
29
29
|
Call the discovered operations with `call_api`; the server supplies company and
|
|
30
30
|
authentication context. Read the returned schemas before drafting the hire.
|
|
31
31
|
|
|
32
|
-
The
|
|
33
|
-
`
|
|
32
|
+
The MCP tool examples below apply to adapters that reach Paperclip through the
|
|
33
|
+
`paperclip*` MCP tools. Paperclip Runner does not expose those tools. Do not
|
|
34
34
|
search workspace files for a server address or credentials to recreate that path.
|
|
35
35
|
If `search_api` / `call_api` are unavailable, report that hiring requires the
|
|
36
36
|
operator to enable runner API tools for this company. Preserve the proposed hire
|
|
37
37
|
in the conversation; do not claim an agent was created or substitute a temporary
|
|
38
38
|
subagent for the requested permanent hire.
|
|
39
39
|
|
|
40
|
+
The hiring tools — `paperclipListAgentConfigurations`, `paperclipCreateAgentHire`
|
|
41
|
+
— live in the `extended` toolset: they are available when the operator enables
|
|
42
|
+
`PAPERCLIP_MCP_TOOLSETS=core,extended`; otherwise call the same operation through
|
|
43
|
+
`paperclipApiRequest` (`method`, `path` relative to `/api`, `jsonBody` as a JSON
|
|
44
|
+
string). `companyId` arguments default to the session's company, so pass one only
|
|
45
|
+
when hiring into a different company.
|
|
46
|
+
|
|
40
47
|
### 1. Confirm identity and company context
|
|
41
48
|
|
|
42
|
-
|
|
43
|
-
curl -sS "$PAPERCLIP_API_URL/api/agents/me" \
|
|
44
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
45
|
-
```
|
|
49
|
+
Call `paperclipMe` with no arguments.
|
|
46
50
|
|
|
47
51
|
### 2. Discover adapter configuration for this Paperclip instance
|
|
48
52
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
53
|
+
The adapter documents are plain text, not JSON tools, so read them with
|
|
54
|
+
`paperclipApiRequest`:
|
|
52
55
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
56
|
-
```
|
|
56
|
+
- all adapters: `method: "GET"`, `path: "/llms/agent-configuration.txt"`
|
|
57
|
+
- the specific adapter you plan to use: `method: "GET"`, `path: "/llms/agent-configuration/claude_local.txt"`
|
|
57
58
|
|
|
58
59
|
### 3. Compare existing agent configurations
|
|
59
60
|
|
|
60
|
-
|
|
61
|
-
curl -sS "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/agent-configurations" \
|
|
62
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
63
|
-
```
|
|
61
|
+
Call `paperclipListAgentConfigurations` (`extended`).
|
|
64
62
|
|
|
65
63
|
Note naming, icon, reporting-line, and adapter conventions the company already follows.
|
|
66
64
|
|
|
@@ -82,10 +80,8 @@ State which path you took in your hire-request comment so the board can see the
|
|
|
82
80
|
|
|
83
81
|
### 5. Discover allowed agent icons
|
|
84
82
|
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
88
|
-
```
|
|
83
|
+
Read the icon list with `paperclipApiRequest` (`method: "GET"`,
|
|
84
|
+
`path: "/llms/agent-icons.txt"`); it is a plain-text document.
|
|
89
85
|
|
|
90
86
|
### 6. Draft the new hire config
|
|
91
87
|
|
|
@@ -111,25 +107,25 @@ Before submitting, walk the draft-review checklist end-to-end and fix any item t
|
|
|
111
107
|
|
|
112
108
|
### 8. Submit hire request
|
|
113
109
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
|
117
|
-
-H "Content-Type: application/json" \
|
|
118
|
-
-d '{
|
|
119
|
-
"name": "CTO",
|
|
120
|
-
"role": "cto",
|
|
121
|
-
"title": "Chief Technology Officer",
|
|
122
|
-
"icon": "crown",
|
|
123
|
-
"reportsTo": "<ceo-agent-id>",
|
|
124
|
-
"capabilities": "Owns technical roadmap, architecture, staffing, execution",
|
|
125
|
-
"desiredSkills": ["vercel-labs/agent-browser/agent-browser"],
|
|
126
|
-
"adapterType": "codex_local",
|
|
127
|
-
"adapterConfig": {"cwd": "/abs/path/to/repo", "model": "o4-mini"},
|
|
128
|
-
"instructionsBundle": {"files": {"AGENTS.md": "You are the CTO..."}},
|
|
129
|
-
"runtimeConfig": {"heartbeat": {"enabled": false, "wakeOnDemand": true}},
|
|
130
|
-
"sourceIssueId": "<issue-id>"
|
|
131
|
-
}'
|
|
110
|
+
Call `paperclipCreateAgentHire` (`extended`) with the drafted fields as arguments:
|
|
111
|
+
|
|
132
112
|
```
|
|
113
|
+
name: "CTO"
|
|
114
|
+
role: "cto"
|
|
115
|
+
title: "Chief Technology Officer"
|
|
116
|
+
icon: "crown"
|
|
117
|
+
reportsTo: "<ceo-agent-id>"
|
|
118
|
+
capabilities: "Owns technical roadmap, architecture, staffing, execution"
|
|
119
|
+
desiredSkills: ["vercel-labs/agent-browser/agent-browser"]
|
|
120
|
+
adapterType: "codex_local"
|
|
121
|
+
adapterConfig: {"cwd": "/abs/path/to/repo", "model": "o4-mini"}
|
|
122
|
+
instructionsBundle: {"files": {"AGENTS.md": "You are the CTO..."}}
|
|
123
|
+
runtimeConfig: {"heartbeat": {"enabled": false, "wakeOnDemand": true}}
|
|
124
|
+
sourceIssueId: "<issue-id>"
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
If the tool returns an error, the hire was not created: fix the reported field and
|
|
128
|
+
call it again rather than reporting a pending hire.
|
|
133
129
|
|
|
134
130
|
### 9. Handle governance state
|
|
135
131
|
|
|
@@ -137,34 +133,21 @@ curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/agent-h
|
|
|
137
133
|
- monitor and discuss on the approval thread
|
|
138
134
|
- when the board approves, you will be woken with `PAPERCLIP_APPROVAL_ID`; read linked issues and close/comment follow-up
|
|
139
135
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
136
|
+
Read the approval with `paperclipGetApproval` (`approvalId`), and comment on the
|
|
137
|
+
thread with `paperclipAddApprovalComment`:
|
|
143
138
|
|
|
144
|
-
curl -sS -X POST "$PAPERCLIP_API_URL/api/approvals/<approval-id>/comments" \
|
|
145
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
|
146
|
-
-H "Content-Type: application/json" \
|
|
147
|
-
-d '{"body":"## CTO hire request submitted\n\n- Approval: [<approval-id>](/approvals/<approval-id>)\n- Pending agent: [<agent-ref>](/agents/<agent-url-key-or-id>)\n- Source issue: [<issue-ref>](/issues/<issue-identifier-or-id>)\n\nUpdated prompt and adapter config per board feedback."}'
|
|
148
139
|
```
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
```sh
|
|
153
|
-
curl -sS -X POST "$PAPERCLIP_API_URL/api/issues/<issue-id>/approvals" \
|
|
154
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
|
155
|
-
-H "Content-Type: application/json" \
|
|
156
|
-
-d '{"approvalId":"<approval-id>"}'
|
|
140
|
+
approvalId: "<approval-id>"
|
|
141
|
+
body: "## CTO hire request submitted\n\n- Approval: [<approval-id>](/approvals/<approval-id>)\n- Pending agent: [<agent-ref>](/agents/<agent-url-key-or-id>)\n- Source issue: [<issue-ref>](/issues/<issue-identifier-or-id>)\n\nUpdated prompt and adapter config per board feedback."
|
|
157
142
|
```
|
|
158
143
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
```sh
|
|
162
|
-
curl -sS "$PAPERCLIP_API_URL/api/approvals/$PAPERCLIP_APPROVAL_ID" \
|
|
163
|
-
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
|
|
144
|
+
If the approval already exists and needs manual linking to the issue, call
|
|
145
|
+
`paperclipLinkIssueApproval` (`issueId`, `approvalId`).
|
|
164
146
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
147
|
+
After approval is granted, run this follow-up loop: `paperclipGetApproval`
|
|
148
|
+
(`approvalId: PAPERCLIP_APPROVAL_ID`) for the decision, then
|
|
149
|
+
`paperclipGetApprovalIssues` (`approvalId: PAPERCLIP_APPROVAL_ID`) for the linked
|
|
150
|
+
issues.
|
|
168
151
|
|
|
169
152
|
For each linked issue, either:
|
|
170
153
|
- close it if the approval resolved the request, or
|
|
@@ -1,37 +1,36 @@
|
|
|
1
1
|
# Paperclip Create Agent API Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
- `
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
Approval
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
Request body matches agent create shape:
|
|
3
|
+
## Tools
|
|
4
|
+
|
|
5
|
+
Tools marked extended load only when the operator enables `PAPERCLIP_MCP_TOOLSETS=core,extended`; otherwise use `paperclipApiRequest` (`method`, `path` relative to `/api`, `jsonBody` as a JSON string) for the same job.
|
|
6
|
+
|
|
7
|
+
| Job | Tool | Key arguments |
|
|
8
|
+
| --- | ---- | ------------- |
|
|
9
|
+
| Read the company adapter-configuration catalogue | `paperclipListAgentConfigurations` (extended) | `companyId` |
|
|
10
|
+
| List the company skill library | `paperclipListSkills` | `companyId` |
|
|
11
|
+
| Import a skill into the company library | `paperclipImportSkill` (extended) | `companyId`, import fields |
|
|
12
|
+
| Read one agent's resolved configuration | `paperclipGetAgentConfiguration` (extended) | `id` |
|
|
13
|
+
| Sync skills onto an agent | `paperclipSyncAgentSkill` (extended) | `id`, sync fields |
|
|
14
|
+
| Submit a hire request (agent draft + approval) | `paperclipCreateAgentHire` (extended) | `companyId`, hire fields below |
|
|
15
|
+
| Create an agent directly, no approval | `paperclipCreateAgent` (extended) | `companyId`, same shape as the hire fields |
|
|
16
|
+
| List agent config revisions | `paperclipListAgentConfigRevisions` (extended) | `id` |
|
|
17
|
+
| Roll back a config revision | `paperclipRollbackAgentConfigRevision` (extended) | `id`, `revisionId` |
|
|
18
|
+
| Link an approval to an issue | `paperclipLinkIssueApproval` | `issueId`, `approvalId` |
|
|
19
|
+
| List issues linked to an approval | `paperclipGetApprovalIssues` | `approvalId` |
|
|
20
|
+
| Approval details | `paperclipGetApproval` | `approvalId` |
|
|
21
|
+
| Approval comments | `paperclipListApprovalComments` | `approvalId` |
|
|
22
|
+
| Add an approval comment | `paperclipAddApprovalComment` | `approvalId`, `body` |
|
|
23
|
+
| Approve, reject, request revision (board), or resubmit | `paperclipApprovalDecision` | `approvalId`, `action` (`approve`, `reject`, `requestRevision`, `resubmit`), `decisionNote`, `payloadJson`. Agents may only use `resubmit`. |
|
|
24
|
+
|
|
25
|
+
Adapter documentation and the icon catalogue are plain-text documents published by the deployment at `/llms/agent-configuration.txt`, `/llms/agent-configuration/<adapterType>.txt`, and `/llms/agent-icons.txt`. They are documentation, not API operations, and have no tool; `paperclipListAgentConfigurations` returns the structured adapter-configuration catalogue.
|
|
26
|
+
|
|
27
|
+
## `paperclipCreateAgentHire`
|
|
28
|
+
|
|
29
|
+
Arguments match the agent create shape:
|
|
32
30
|
|
|
33
31
|
```json
|
|
34
32
|
{
|
|
33
|
+
"companyId": "{companyId}",
|
|
35
34
|
"name": "CTO",
|
|
36
35
|
"role": "cto",
|
|
37
36
|
"title": "Chief Technology Officer",
|
|
@@ -62,7 +61,7 @@ Request body matches agent create shape:
|
|
|
62
61
|
}
|
|
63
62
|
```
|
|
64
63
|
|
|
65
|
-
|
|
64
|
+
Result:
|
|
66
65
|
|
|
67
66
|
```json
|
|
68
67
|
{
|
|
@@ -103,7 +102,7 @@ For hire approvals:
|
|
|
103
102
|
|
|
104
103
|
## Safety Notes
|
|
105
104
|
|
|
106
|
-
- Config read
|
|
105
|
+
- Config read tools redact obvious secrets.
|
|
107
106
|
- `pending_approval` agents cannot run heartbeats, receive assignments, or create keys.
|
|
108
107
|
- All actions are logged in activity for auditability.
|
|
109
108
|
- Use markdown in issue/approval comments and include links to approval, agent, and source issue.
|