Skip to main content
Glama

Pipeworx Faq

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Pipeworx Getting Started

pipeworx_getting_started
Read-onlyIdempotent

Step-by-step instructions for connecting an AI client to Pipeworx — Claude Code, claude.ai, Cursor, Windsurf, Gemini CLI, Perplexity, ChatGPT, or any MCP-capable client. Returns the gateway URL, plugin links, and first-question suggestions. Example: pipeworx_getting_started({ client: "cursor" })

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
clientNoOptional client name, e.g. "claude code", "cursor", "windsurf", "gemini", "perplexity", "chatgpt". Omit for generic MCP instructions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "client": "cursor"
+  },
+  {
+    "client": "claude code"
+  }
+]
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already mark the tool as readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds that it returns gateway URL, plugin links, and suggestions, which is consistent. No contradictions.

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?

Two sentences with no redundant words. Front-loaded with purpose, includes example. Every sentence earns its place.

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?

For a simple read-only tool with one optional parameter, the description fully explains what to expect and how to use it. No output schema needed. Annotations cover behavioral traits.

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?

Parameter 'client' is fully documented in the input schema with examples. The description reinforces with an example call. Since schema coverage is 100%, the description adds marginal value but the example is helpful.

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?

Description clearly states it provides step-by-step instructions for connecting AI clients to Pipeworx, listing specific clients and outputs (gateway URL, plugin links, suggestions). It distinguishes from siblings like about_pipeworx and ask_pipeworx.

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?

Description includes an explicit example of invocation and specifies the return content. It does not explicitly exclude use cases or name alternatives, but the example and context make usage straightforward for an agent.

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

All Pipeworx Faq toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources