paperclip_get_project
Retrieve a project by UUID, including its workspaces, to view details or determine the current workspace directory before checking out a branch.
Instructions
Get a single project by UUID, including its associated workspaces.
Args:
projectId: string — Project UUID (example: "prj_abc123")
response_format: 'markdown' | 'json' (optional) — Output format (default: markdown)
Returns: Project object: id, name, description, status, goalId, workspaces[], createdAt.
Examples:
Use when: reading project details or checking workspace cwd before checking out a branch
Don't use when: you need a list of projects — use paperclip_list_projects to discover IDs first
Error Handling:
401: authentication failed → check PAPERCLIP_API_KEY
404: project not found → verify ID with paperclip_list_projects
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | Project UUID | |
| response_format | Yes | Output format: 'markdown' (default, human-readable) or 'json' (structured) | markdown |