references/company-skills.md
references/company-skills.mdBrowse 9 files
10,214 bytes
Token encoding: o200k_base
Snapshot 5b913e7
Company Skills Workflow
Use this reference when a board user, CEO, or manager asks you to find a skill, install it into the company library, or assign it to an agent.
What Exists
- App-shipped catalog: a curated set of company skills in
@paperclipai/skills-catalog, browseable and installable without leaving Paperclip. - Company skill library: install, inspect, update, audit, reset, and read company skills for the whole company.
- Agent skill assignment: add or remove company skills on an existing agent.
- Hire/create composition: pass
desiredSkillswhen creating or hiring an agent so the same assignment model applies immediately.
The canonical model is:
- add the skill to the company library — either from the app catalog (
skills install), an external source (skills import), or a managed local skill (skills create/skills scan-projects) - attach the company skill to the agent (
skills agent sync) - optionally do step 2 during hire/create with
desiredSkills
Catalog install ≠ agent attach. Installing a catalog skill only adds the row to
company_skills. The agent will not use it until you sync the agent's desired
set.
Permission Model
- Company skill reads: any same-company actor
- Company skill mutations: open to same-company actors by default. Missing
skills:creategrants andcanCreateSkillssettings do not deny ordinary skill work; only an explicit company skill policy restriction does. Core safety and company-boundary checks always remain enforced. - Agent skill assignment: same permission model as updating that agent
- Team installs continue to require
agents:createbecause they import or create agents in addition to attaching skills.
Core Endpoints
App-shipped catalog (read-only browse + company install):
GET /api/skills/catalogGET /api/skills/catalog/:catalogIdGET /api/skills/catalog/ref?ref=<id|key|slug>GET /api/skills/catalog/:catalogId/files?path=SKILL.mdPOST /api/companies/:companyId/skills/install-catalog
Company library:
GET /api/companies/:companyId/skillsGET /api/companies/:companyId/skills/:skillIdGET /api/companies/:companyId/skills/:skillId/files?path=SKILL.mdPOST /api/companies/:companyId/skills(managed local create)POST /api/companies/:companyId/skills/importPOST /api/companies/:companyId/skills/scan-projectsGET /api/companies/:companyId/skills/:skillId/update-statusPOST /api/companies/:companyId/skills/:skillId/install-updatePOST /api/companies/:companyId/skills/:skillId/auditPOST /api/companies/:companyId/skills/:skillId/resetDELETE /api/companies/:companyId/skills/:skillId
Agent attach and hire/create composition:
GET /api/agents/:agentId/skillsPOST /api/agents/:agentId/skills/syncPOST /api/companies/:companyId/agent-hiresPOST /api/companies/:companyId/agents
If a board user, CEO, or manager is driving locally, prefer the
paperclipai skills CLI documented in doc/CLI.md — it wraps every endpoint
above, accepts company skill or catalog refs by id/key/slug, and prints
the same JSON these endpoints return when called with --json.
Install A Skill Into The Company
Two paths cover the common cases:
- App-shipped catalog (preferred when the right skill exists in the bundled/optional catalog) — browse it first, then install with the catalog install endpoint. No external network fetch happens.
- External source (skills.sh, GitHub, local path, or URL) — use the import endpoint below.
App-shipped catalog
Browse, inspect, and install catalog skills before reaching for an external source. Bundled skills are the curated defaults for any company; optional skills are role- or domain-specific.
curl -sS "$PAPERCLIP_API_URL/api/skills/catalog?kind=bundled" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
curl -sS "$PAPERCLIP_API_URL/api/skills/catalog/ref?ref=github-pr-workflow" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/install-catalog" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"catalogSkillId": "paperclipai:bundled:software-development:github-pr-workflow"
}'
The install response records provenance (catalogId, catalogKey,
packageVersion, originHash) on the company skill so update/audit/reset
flows know the pinned origin. force: true may replace a same-key
catalog-managed skill but never bypasses hard-stop audit findings.
External source import
Import using a skills.sh URL, a key-style source string, a GitHub URL, or a local path.
Source types (in order of preference)
| Source format | Example | When to use |
|---|---|---|
| skills.sh URL | https://skills.sh/google-labs-code/stitch-skills/design-md | When a user gives you a skills.sh link. This is the managed skill registry — always prefer it when available. |
| Key-style string | google-labs-code/stitch-skills/design-md | Shorthand for the same skill — org/repo/skill-name format. Equivalent to the skills.sh URL. |
| GitHub URL | https://github.com/vercel-labs/agent-browser | When the skill is in a GitHub repo but not on skills.sh. |
| Local path | /abs/path/to/skill-dir | When the skill is on disk (dev/testing only). |
Critical: If a user gives you a https://skills.sh/... URL, use that URL or its key-style equivalent (org/repo/skill-name) as the source. Do not convert it to a GitHub URL — skills.sh is the managed registry and the source of truth for versioning, discovery, and updates.
Example: skills.sh import (preferred)
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/import" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "https://skills.sh/google-labs-code/stitch-skills/design-md"
}'
Or equivalently using the key-style string:
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/import" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "google-labs-code/stitch-skills/design-md"
}'
Example: GitHub import
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/import" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "https://github.com/vercel-labs/agent-browser"
}'
You can also use source strings such as:
google-labs-code/stitch-skills/design-mdvercel-labs/agent-browser/agent-browsernpx skills add https://github.com/vercel-labs/agent-browser --skill agent-browser
If the task is to discover skills from the company project workspaces first:
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/scan-projects" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
Inspect What Was Installed
curl -sS "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
Read the skill entry and its SKILL.md:
curl -sS "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/<skill-id>" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
curl -sS "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/skills/<skill-id>/files?path=SKILL.md" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
Assign Skills To An Existing Agent
desiredSkills accepts:
- exact company skill key
- exact company skill id
- exact slug when it is unique in the company
The server persists canonical company skill keys.
The request must include a merge mode:
addadds the named skills and keeps every other assignment.removeremoves only the named skills.replaceoverwrites the complete desired skill set. Use it only after explicit confirmation.
curl -sS -X POST "$PAPERCLIP_API_URL/api/agents/<agent-id>/skills/sync" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mode": "add",
"desiredSkills": [
"vercel-labs/agent-browser/agent-browser"
]
}'
If you need the current state first:
curl -sS "$PAPERCLIP_API_URL/api/agents/<agent-id>/skills" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY"
Include Skills During Hire Or Create
Use the same company skill keys or references in desiredSkills when hiring or creating an agent:
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/agent-hires" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "QA Browser Agent",
"role": "qa",
"adapterType": "codex_local",
"adapterConfig": {
"cwd": "/abs/path/to/repo"
},
"desiredSkills": [
"agent-browser"
]
}'
For direct create without approval:
curl -sS -X POST "$PAPERCLIP_API_URL/api/companies/$PAPERCLIP_COMPANY_ID/agents" \
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "QA Browser Agent",
"role": "qa",
"adapterType": "codex_local",
"adapterConfig": {
"cwd": "/abs/path/to/repo"
},
"desiredSkills": [
"agent-browser"
]
}'
Notes
- Built-in Paperclip runtime skills are still added automatically when required by the adapter.
- If a reference is missing or ambiguous, the API returns
422. - Prefer linking back to the relevant issue, approval, and agent when you comment about skill changes.
- Use company portability routes when you need whole-package import/export, not just a skill:
POST /api/companies/:companyId/imports/previewPOST /api/companies/:companyId/imports/applyPOST /api/companies/:companyId/exports/previewPOST /api/companies/:companyId/exports
- Use skill-only import when the task is specifically to add a skill to the company library without importing the surrounding company/team/package structure.