Skip to main content
Glama
bruhsb
by bruhsb

paperclip_get_company

Read-only

Retrieve a single company's configuration by UUID. Get details on budget, status, branding, and settings.

Instructions

⚠ Board-only: Get a single company by UUID.

Args:

  • companyId: string — Company UUID (example: "00000000-0000-0000-0000-000000000000")

  • response_format: 'markdown' | 'json' (optional) — Output format (default: markdown)

Returns: Company object: id, name, description, status, issuePrefix, issueCounter, budgetMonthlyCents, spentMonthlyCents, requireBoardApprovalForNewAgents, feedbackDataSharingEnabled, brandColor, logoAssetId, pauseReason, pausedAt, createdAt, updatedAt.

Examples:

  • Use when: reading a company's budget, status, or branding configuration

  • Don't use when: you need to list all companies — use paperclip_list_companies to discover IDs first

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
response_formatYesOutput format: 'markdown' (default, human-readable) or 'json' (structured)markdown
Behavior5/5

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

Annotations already declare readOnlyHint=true, but the description adds that the endpoint is 'Board-only' and requires board-level auth (error 403), which is beyond what annotations provide. It also lists return fields and common errors, offering comprehensive behavioral insight.

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 clear sections (Args, Returns, Examples, Error Handling). Front-loaded with purpose and warning. Every sentence is informative and non-redundant.

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?

Given the tool's simplicity (2 parameters, no output schema), the description covers all essential aspects: authentication requirements, parameter details, return fields, usage examples, and error handling. References sibling for list operation, ensuring full context for correct use.

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 description coverage is 100% and baseline is 3. The description adds examples (companyId UUID), clarifies response_format enum values and defaults, and lists all return fields, thus providing meaningful extra context beyond the schema.

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 'Get a single company by UUID', specifying the verb and resource. It distinguishes from sibling 'paperclip_list_companies' by explicitly stating when not to use and directing to the alternative.

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?

Provides explicit when-to-use examples ('reading a company's budget, status, or branding configuration') and when-not-to-use ('need to list all companies'), with a direct alternative. Also includes error handling guidance for auth and not found scenarios.

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