Skip to main content
Glama
Sign In
BitPull

BitPull

by SamuealPK
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

prepare_publish

Read-only

Create a bitpull.json draft for an authorized local folder, fill in empty descriptions, and call publish_repo to publish the repository.

Instructions

Create a bitpull.json draft for a local folder the user authorised. Fill the empty descriptions, then call publish_repo.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "folder": "<folder>"
    },
    "name": "prepare_publish"
  }
}

Input Schema

NameRequiredDescriptionDefault
folderYesAbsolute path of the folder

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotation says readOnlyHint=true, and the description is consistent: it creates a local *draft* file, and the actual publishing is explicitly deferred to publish_repo, so no server-side write is implied. It adds useful workflow context beyond the annotation, but does not say whether an existing bitpull.json is overwritten, whether it fails on unauthorised folders, or what the draft contains.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the action and artifact, followed by the next step. No filler. Slight loss for the slightly compressed phrasing "Fill the empty descriptions," which leaves the referent implicit.

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

Completeness4/5

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

For a one-parameter draft-creation step with full schema coverage and no output schema, the description covers purpose, prerequisite hint, and the follow-up tool. Missing only failure behavior (unauthorised folder, existing file) and what the draft contains.

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% and the single folder parameter is documented as an absolute path. The description adds the meaningful constraint that the folder must be one the user authorised, which the schema does not state. Baseline 3 applies since schema does the heavy lifting.

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?

Specific verb+artifact: "Create a bitpull.json draft for a local folder". It names the output artifact (bitpull.json draft) and the precondition (folder the user authorised), which distinguishes it from bitpull_publish_site or publish_repo without needing the schema. It doesn't explicitly say how it differs from sibling creation tools, but the artifact name is distinctive.

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?

Gives a clear workflow: create the draft, fill the empty descriptions, then call publish_repo. "the user authorised" implies a prerequisite (bitpull_authorize_folder must have run), though it doesn't name that tool or state what to do if the folder is unauthorised.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools