paperclip_preview_company_import
Simulate importing a company bundle to inspect resource changes, agent conflicts, and proposed overrides before committing the import.
Instructions
⚠ Board-only: Preview company import
Args:
companyId: string — Target company UUID
source: union — { type: 'inline', rootPath: string, files: Record<string,string> } or { type: 'github', url: string }
include: object — Which resource types to preview (company, agents, projects, issues, skills)
target: object — { mode: 'existing_company' | 'new_company', companyId: string } — must match the top-level companyId
agents: 'all' | string[] (optional) — Which agents to import (default: 'all')
collisionStrategy: 'rename' | 'skip' | 'replace' (optional) — Collision handling (default: rename)
selectedFiles: string[] (optional) — Subset of bundle files to process
Returns: Preview report (JSON only): { source, target, agents, projects, issues, skills, warnings, adapterOverrides }. Non-mutating — no changes are applied. Note: openWorldHint is false; if source.type is 'github', the API fetches external content.
Examples:
Use when: inspecting what an import would change before committing; also generates adapterOverrides for the apply step
Don't use when: you want to immediately apply — call paperclip_apply_company_import directly (preview is optional but recommended)
Error Handling:
400: invalid bundle → check source files and rootPath
401: authentication failed → check PAPERCLIP_API_KEY
403: board key required → this endpoint requires board-level authentication
404: company not found → verify ID with paperclip_list_companies
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyId | Yes | Target company UUID for the import preview | |
| source | Yes | Bundle source: 'inline' provides files in the request; 'github' fetches from a repo URL | |
| include | Yes | Which resource types to consider during the import (company, agents, projects, issues, skills) | |
| target | Yes | Import destination | |
| agents | Yes | Which agents to import: literal 'all' or an array of agent URL keys | all |
| collisionStrategy | Yes | How to handle name/key collisions: 'rename' (append suffix), 'skip' (leave existing), 'replace' (overwrite) | rename |
| selectedFiles | No | Subset of file paths from the bundle to process (omit for all files in the bundle) |