Skip to main content
Glama
bruhsb
by bruhsb

paperclip_list_secrets

Read-only

List all registered secrets for a company and view their metadata without exposing secret values. Enables auditing of secret configurations with pagination support.

Instructions

⚠ Board-only: List secrets registered for a company. Returns metadata only — secret values are never included in any response.

Args:

  • companyId: string — Company UUID

  • limit: number (optional) — Max results per page (1–100, default 50)

  • offset: number (optional) — Number of records to skip (default 0)

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

Returns: Pagination envelope { items: Secret[], total, count, offset, limit, has_more, next_offset }. Each item: id, companyId, name, provider, externalRef, latestVersion, description, createdByAgentId, createdByUserId, createdAt, updatedAt. Value field is never present.

Examples:

  • Use when: auditing which secrets are registered for a company or checking a specific secret's metadata

  • Don't use when: you need to rotate or update a secret — use paperclip_rotate_secret or paperclip_update_secret instead

Error Handling:

  • 401: authentication failed → check PAPERCLIP_API_KEY

  • 403: permission denied → this tool requires a board (human-user) API key

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
companyIdYesCompany UUID
limitYesMax secrets per page (1–100, default 50)
offsetYesNumber of secrets to skip (default 0)
response_formatYesOutput format: 'markdown' (default, human-readable) or 'json' (structured)markdown
Behavior4/5

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

Annotations already declare readOnlyHint=true. Description adds that secret values are never returned and explains error conditions, but could provide more insight into pagination behavior or outcomes beyond the schema.

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 important caution about secrets. Every sentence is informative and concise.

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?

Completely covers the tool's purpose, parameters, return format (pagination envelope with field list), usage guidelines, and error scenarios. No missing context for a list operation.

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

Parameters3/5

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

Schema coverage is 100% with descriptions for all parameters. The description repeats these but adds no additional semantic meaning beyond what the schema already provides.

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 it lists secrets for a company and returns only metadata. It distinguishes from siblings like rotate/update by specifying the action and never returning secret values.

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?

Explicitly provides use cases (auditing, checking metadata) and when not to use (rotate/update) with specific tool names. Also includes error handling guidance for auth and permissions.

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