Skip to main content
Glama

cancelPinRequest

Cancel a pending IPFS pin request by providing its ID to stop the pinning process.

Instructions

Cancel a pending pin by CID request

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesID of the pin request to cancel

Implementation Reference

  • The complete cancelPinRequest tool implementation - registered as an MCP tool with schema definition (id parameter) and async handler that makes a DELETE request to cancel a pending pin by CID request
    server.tool(
      "cancelPinRequest",
      "Cancel a pending pin by CID request",
      {
        id: z.string().describe("ID of the pin request to cancel"),
      },
      async ({ id }) => {
        try {
          const url = `https://api.pinata.cloud/v3/files/public/pin_by_cid/${id}`;
    
          const response = await fetch(url, {
            method: "DELETE",
            headers: getHeaders(),
          });
    
          if (!response.ok) {
            throw new Error(
              `Failed to cancel pin request: ${response.status} ${response.statusText}`
            );
          }
    
          const data = await response.json();
          return {
            content: [
              {
                type: "text",
                text: `✅ Pin request cancelled\n\n${JSON.stringify(data, null, 2)}`,
              },
            ],
          };
        } catch (error) {
          return errorResponse(error);
        }
      }
    );
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states the action is 'Cancel' (implying mutation/reversal), but doesn't address permissions needed, whether cancellation is reversible, error conditions, or what happens upon success. This leaves significant behavioral gaps for a mutation tool.

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?

The description is a single, efficient sentence with zero wasted words. It's front-loaded with the core action and target, making it immediately scannable and appropriately sized for the tool's apparent complexity.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description is insufficient. It doesn't explain what 'cancel' entails operationally, what the expected outcome is, or any side effects. Given the context of managing pin requests, more completeness is needed to guide effective use.

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 description coverage is 100% (the 'id' parameter is fully described in the schema), so the baseline is 3. The description doesn't add any parameter-specific details beyond what the schema already provides about the 'id' being for the pin request to cancel.

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

Purpose4/5

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

The description clearly states the action ('Cancel') and target resource ('a pending pin by CID request'), making the purpose immediately understandable. It doesn't explicitly differentiate from siblings like 'deleteFile' or 'deletePaymentInstruction', but the specificity of 'pending pin by CID request' provides inherent distinction.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., that the pin request must be in a pending state), nor does it reference related tools like 'pinByCid' or 'queryPinRequests' for context.

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/PinataCloud/pinata-mcp'

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