Skip to main content
Glama
Monyeah777

NinFenz Content Gate

Fetch pipeline document

pipeline_read
Read-onlyIdempotent

Reads one NF pipeline's full Markdown by P-number or repo-relative path, returning complete text for a known pipeline. Use after pipeline_list identifies it; a missing pipeline is an error.

Instructions

Read one NF pipeline's full Markdown by P-number or repository-relative path. Use it after pipeline_list identifies a pipeline; do not use it to list pipelines (use pipeline_list instead) or read modules/assets (module_read / asset_read). pipeline is either a Pxx stem (P01, matched against the filename prefix) or a .md path under 03_管线库/ or a community pipelines/ directory; paths outside those roots and .. escapes are rejected. A missing pipeline is an error, not an empty result; reads one local file and returns its full text without truncation. Local-only; no auth or rate limits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pipelineYesPxx stem (P01) or repository-relative .md path under 03_管线库/ or community/*/pipelines/.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesRepository-relative Markdown path.
textYesFull pipeline Markdown as stored on disk.
bytesYesUTF-8 byte length of text.
foundYesTrue when the pipeline was located.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already cover readOnly/idempotent/non-destructive/closed-world, and the description adds context beyond them: local-only with no auth or rate limits, a missing pipeline is an error rather than an empty result, no truncation, and path-validation rules rejecting roots outside 03_管线库/ and community/*/pipelines/ and '..' escapes.

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?

Front-loaded with the core action, then constraints and error semantics in tight order; content is dense but every sentence carries a distinct fact. Slightly longer than minimal, but no filler.

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 single-parameter read tool with an output schema, everything an agent needs is present: usage routing, accepted identifier forms, path restrictions, and error behavior. Return format is correctly left to the output schema.

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 is 100% and the schema already documents the single 'pipeline' parameter, but the prose adds real meaning beyond it: the Pxx stem is matched against the filename prefix, and the accepted path roots and the '..' escape rejection clarify the accepted syntax.

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?

States a specific verb+resource: 'Read one NF pipeline's full Markdown by P-number or repository-relative path.' It explicitly distinguishes itself from pipeline_list, module_read and asset_read in the same breath, so an agent can select it without opening any schema.

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?

Gives explicit when-to-use ('after pipeline_list identifies a pipeline') and when-not-to-use with named alternatives for both the listing case (pipeline_list) and the module/asset case (module_read / asset_read). Routing guidance is complete.

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