Skip to main content
Glama

list_yaml_examples

Browse ready-to-use YAML configuration examples for Ludus cyber range deployments, including AD labs, SIEM integration, and web app security testing environments.

Instructions

List all available YAML configuration examples.

Returns ready-to-use YAML configuration examples that can be directly saved to a file and deployed with Ludus.

Available examples:

  • basic_ad: Basic AD lab with DC, workstations, and attacker

  • with_siem: AD lab with Wazuh SIEM for blue team training

  • web_app_lab: Web application security testing lab

Returns: Dictionary with example names and descriptions

Example: examples = await list_yaml_examples() # Then use get_yaml_example("basic_ad") to get the YAML content

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/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 effectively discloses key behaviors: the tool returns a dictionary with example names and descriptions, and the examples are directly usable for deployment. However, it lacks details on potential errors, rate limits, or authentication needs, which are minor gaps given the tool's simple read-only nature.

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 front-loaded with the core purpose, followed by details on examples and returns, and ends with a practical usage example. Every sentence earns its place by providing essential information without redundancy, making it efficient and well-structured.

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?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is complete. It covers the purpose, usage, behavioral output, and includes an example, leaving no gaps for the agent to understand and invoke the tool correctly in this context.

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?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description appropriately focuses on output semantics by explaining the return format (dictionary with names and descriptions) and providing an example, adding value beyond 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 explicitly states the verb ('List') and resource ('all available YAML configuration examples'), making the purpose specific and clear. It distinguishes itself from sibling tools like 'get_yaml_example' by focusing on listing examples rather than retrieving content, which is evident from the example provided.

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?

The description provides explicit guidance on when to use this tool: to get ready-to-use YAML examples for deployment with Ludus. It also names an alternative tool ('get_yaml_example') for retrieving specific YAML content, clearly differentiating usage contexts and preventing confusion with siblings.

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

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/tjnull/Ludus-FastMCP'

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