Skip to main content
Glama

w3_can_upload_add

Manually register an upload DAG by its root CID and shard CIDs for advanced use, typically after manually storing CAR shards on the MCP IPFS server.

Instructions

Manually registers an upload DAG by its root CID and shard CIDs (advanced use). This is typically used after storing CAR shards manually.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rootCidYesRoot data CID of the DAG to register.
shardCidsYesOne or more shard CIDs where the DAG data is stored.

Implementation Reference

  • The handler function that implements the core logic for the 'w3_can_upload_add' tool. It validates input using the schema, executes the 'w3 can upload add' command with rootCid and shardCids, and formats the response.
    const handleW3CanUploadAdd: ToolHandler = async (args) => {
      const parsed = Schemas.W3CanUploadAddArgsSchema.safeParse(args);
      if (!parsed.success)
        throw new Error(
          `Invalid arguments for w3_can_upload_add: ${parsed.error.message}`
        );
      const { rootCid, shardCids } = parsed.data;
      const shards = shardCids.join(" ");
      const { stdout } = await runW3Command(`can upload add ${rootCid} ${shards}`);
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify({
              message: `Upload with root ${rootCid} registered successfully.`,
              output: stdout.trim(),
            }),
          },
        ],
      };
    };
  • Zod schema defining the input arguments for the w3_can_upload_add tool: rootCid (string) and shardCids (array of strings, min 1). Includes descriptions.
    export const W3CanUploadAddArgsSchema = z
      .object({
        rootCid: z.string().describe("Root data CID of the DAG to register."),
        shardCids: z
          .array(z.string())
          .min(1)
          .describe("One or more shard CIDs where the DAG data is stored."),
      })
      .describe(
        "Manually registers an upload DAG by its root CID and shard CIDs (advanced use). This is typically used after storing CAR shards manually."
      );
  • The toolHandlers object registers 'w3_can_upload_add' mapped to its handleW3CanUploadAdd function, making it available for the MCP server.
    export const toolHandlers: Record<string, ToolHandler> = {
      w3_login: handleW3Login,
      w3_space_ls: handleW3SpaceLs,
      w3_space_use: handleW3SpaceUse,
      w3_space_create: handleW3SpaceCreate,
      w3_up: handleW3Up,
      w3_ls: handleW3Ls,
      w3_rm: handleW3Rm,
      w3_open: handleW3Open,
      w3_space_info: handleW3SpaceInfo,
      w3_space_add: handleW3SpaceAdd,
      w3_delegation_create: handleW3DelegationCreate,
      w3_delegation_ls: handleW3DelegationLs,
      w3_delegation_revoke: handleW3DelegationRevoke,
      w3_proof_add: handleW3ProofAdd,
      w3_proof_ls: handleW3ProofLs,
      w3_key_create: handleW3KeyCreate,
      w3_bridge_generate_tokens: handleW3BridgeGenerateTokens,
      w3_can_blob_add: handleW3CanBlobAdd,
      w3_can_blob_ls: handleW3CanBlobLs,
      w3_can_blob_rm: handleW3CanBlobRm,
      w3_can_index_add: handleW3CanIndexAdd,
      w3_can_upload_add: handleW3CanUploadAdd,
      w3_can_upload_ls: handleW3CanUploadLs,
      w3_can_upload_rm: handleW3CanUploadRm,
      w3_plan_get: handleW3PlanGet,
      w3_account_ls: handleW3AccountLs,
      w3_space_provision: handleW3SpaceProvision,
      w3_coupon_create: handleW3CouponCreate,
      w3_usage_report: handleW3UsageReport,
      w3_can_access_claim: handleW3CanAccessClaim,
      w3_can_store_add: handleW3CanStoreAdd,
      w3_can_store_ls: handleW3CanStoreLs,
      w3_can_store_rm: handleW3CanStoreRm,
      w3_can_filecoin_info: handleW3CanFilecoinInfo,
      w3_reset: handleW3Reset,
    };
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It indicates this is a 'manual registration' tool for 'advanced use,' which implies it's a write operation that requires specific knowledge. However, it lacks details on permissions needed, side effects, error conditions, or what happens after registration (e.g., does it verify shards?). This leaves behavioral gaps for an agent.

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 two sentences that are front-loaded with the core purpose and followed by usage context. Every word earns its place with zero waste, making it highly efficient and easy to parse.

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

Completeness3/5

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

For a tool with 2 parameters, no annotations, and no output schema, the description is adequate but incomplete. It covers the purpose and basic usage but lacks details on behavioral aspects like authentication requirements, rate limits, or return values. Given the complexity of a manual registration operation, more context would be beneficial for an agent.

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%, with both parameters (rootCid, shardCids) well-documented in the schema. The description adds minimal value beyond the schema by reinforcing the purpose but doesn't provide additional context like format examples or constraints. Baseline 3 is appropriate given the high schema coverage.

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 specific action ('manually registers an upload DAG') and identifies the resources involved ('by its root CID and shard CIDs'). It distinguishes this tool from sibling tools like w3_can_upload_ls and w3_can_upload_rm by focusing on registration rather than listing or removal.

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

Usage Guidelines4/5

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

The description provides clear context about when to use this tool ('typically used after storing CAR shards manually') and labels it as 'advanced use,' which helps guide appropriate usage. However, it doesn't explicitly state when not to use it or name specific alternatives among the sibling tools.

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

Related 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/alexbakers/mcp-ipfs'

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