Skip to main content
Glama
bruhsb
by bruhsb

paperclip_get_goal

Read-only

Fetch a single goal by UUID to view its status and linked projects, helping you verify details before creating an issue.

Instructions

Get a single goal by UUID, including its status and linked projects.

Args:

  • goalId: string — Goal UUID (example: "gol_abc123")

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

Returns: Goal object: id, title, description, status, level, parentId, linkedProjects[], createdAt.

Examples:

  • Use when: reading a goal's current status or linked projects before creating an issue under it

  • Don't use when: you need a list of goals — use paperclip_list_goals to discover IDs first

Error Handling:

  • 401: authentication failed → check PAPERCLIP_API_KEY

  • 404: goal not found → verify ID with paperclip_list_goals

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
goalIdYesGoal 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 declare readOnlyHint=true, description adds return fields and error codes. No contradiction.

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?

Clear sections (Args, Returns, Examples, Error Handling). Concise and well-organized.

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?

No output schema, but description lists returned fields and error codes. Complete for a read tool.

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 100% so baseline 3, but description adds context like UUID format, default output format, and examples.

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?

Clearly states it gets a single goal by UUID, including status and linked projects. Distinguishes from list tool.

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 when-to-use (reading goal status before creating issue) and when-not-to (use list_goals for discovery). Includes error handling guidance.

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