Skip to main content
Glama
railyard-sh

Railyard MCP Server

by railyard-sh

Export project

export_project
Read-only

Export a Railyard project to downstream formats such as Nautobot CSV, NetBox CSV, or JSON, and retrieve the generated files. Unresolved placements are reported, with optional placeholders for missing device types.

Instructions

Export a project into a downstream format (see list_export_formats for the ids — e.g. nautobot-csv, netbox-csv, designbuilder-yaml, json) and return the generated files' content, plus any unresolved placements and warnings. A placement whose deviceTypeRef matches no catalogue entry is REPORTED, never silently dropped: set placeholders=true to emit it as a placeholder device type so the row still imports. Targets that need prerequisite objects return the whole ordered bundle, not just the headline table. Large files are truncated in the reply — the app's download gives the complete artefact.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgNoOrganisation to target: an org id (org_…), slug, or name. Defaults to RAILYARD_ORG, or to your first (personal) org if that is unset. Use list_orgs to see the options.
refNoA saved project's id (prj_…) or slug to export.
formatYesExport format id, e.g. "nautobot-csv". Use list_export_formats to see them.
projectNoAn inline project document to export instead of a saved one.
placeholdersNoEmit placements with no matching device type as placeholders (default false: they are skipped, but still reported).
fallbackLocationNoLocation name given to racks with no resolvable site (default "Railyard-Unassigned").

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, openWorldHint, and destructiveHint, and the description adds substantial behavior: unresolved placements are reported rather than silently dropped, placeholder emission is opt-in, prerequisite-dependent targets return the full ordered bundle, and large files are truncated in the reply. This is meaningful context beyond the structured annotations.

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 three dense sentences with no wasteful repetition. The first sentence establishes purpose and main output, the second covers a key edge case, and the third addresses truncation. 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?

There is no output schema, so the description correctly takes responsibility for describing return values: file content, unresolved placements, warnings, bundle ordering, and truncation. Combined with full schema coverage of the six parameters, an agent has enough context to invoke the tool correctly.

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?

All six parameters are documented in the schema (100% coverage), so the baseline is 3. The description adds value by clarifying that placeholders=true causes unmapped device types to be emitted as placeholders while the default still reports them, and it gives concrete format examples. This exceeds baseline without duplicating the schema.

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 states a specific verb and resource ('Export a project') and clarifies it produces downstream formats while pointing to list_export_formats for the format ids. This clearly distinguishes it from get_project or list_projects, which retrieve project data rather than exporting artefacts.

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?

It names the relevant helper tools (list_export_formats and list_orgs) and implicitly states the use case: export a saved or inline project into an importable format. It does not explicitly state when not to use it, but the context is clear enough relative to sibling tools.

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