Skip to main content
Glama
bruhsb
by bruhsb

paperclip_export_company

Export a company configuration as a portable snapshot for backup or migration. Select which resource types to include and filter by IDs.

Instructions

⚠ Board-only: Export company package

Args:

  • companyId: string — Company UUID to export

  • include: object — Which resource types to bundle: { company, agents, projects, issues, skills } (booleans with defaults true/true/false/false/false)

  • skills: string[] (optional) — Filter to specific skill IDs

  • projects: string[] (optional) — Filter to specific project IDs

  • issues: string[] (optional) — Filter to specific issue IDs

  • projectIssues: string[] (optional) — Project IDs whose issues to include

  • expandReferencedSkills: boolean (optional) — Expand transitive skill references

Returns: Export bundle (JSON only): { rootPath, manifest, files (map of path → content), paperclipExtensionPath, warnings }. Files can be very large — response is truncated at 25k chars.

Examples:

  • Use when: creating a portable snapshot of a company configuration for backup or migration

  • Don't use when: you want to apply an import bundle — use paperclip_preview_company_import then paperclip_apply_company_import

Error Handling:

  • 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

TableJSON Schema
NameRequiredDescriptionDefault
companyIdYesCompany UUID to export
includeYesWhich resource types to include in the export package (company, agents, projects, issues, skills)
skillsNoFilter export to specific skill IDs (omit for all skills)
projectsNoFilter export to specific project IDs (omit for all projects)
issuesNoFilter export to specific issue IDs (omit for all issues)
projectIssuesNoProject IDs whose issues should be included in the export
expandReferencedSkillsNoWhen true, expand transitive skill references into the export bundle
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses crucial behaviors: Board-only authentication requirement, JSON-only output, response truncation at 25k chars (files can be very large), and error codes. Annotations only provide destructiveHint and title, so description adds substantial value.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with warning, args, returns, examples, and error handling. Each section is concise and front-loaded (first line is 'Board-only: Export company package'). No unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Comprehensively covers purpose, usage, parameters, output format (including truncation example), error handling, and examples. Despite 7 parameters, nested objects, and no output schema, everything needed for correct invocation is present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3. Description adds value by showing default values for include subproperties, clarifying optional filters (e.g., 'omit for all skills'), and explaining expandReferencedSkills. This goes beyond mere repetition.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool exports a company package (specific verb and resource). It includes 'Board-only' to indicate access level and distinguishes from import tools (paperclip_preview_company_import, paperclip_apply_company_import) in the usage examples.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit sections 'Use when' and 'Don't use when' with alternatives provided. Error handling details per HTTP status code (401, 403, 404) give clear corrective actions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bruhsb/paperclip-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server