Skip to main content
Glama
api-commons

Spotlight MCP

by api-commons

validate_ruleset

Structurally validate a ruleset against the engine with an alias, definition object, or YAML/JSON string.

Instructions

Structurally validate a Spotlight ruleset (alias, definition object, or YAML/JSON string) against the engine.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rulesetNoA ruleset definition (object) or a YAML/JSON string.
Behavior2/5

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

With no annotations, the description must disclose behavioral traits. It only says 'structurally validate' without explaining what happens on success/failure, whether it is read-only, or what the return value is. This leaves significant ambiguity.

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?

Single sentence of 16 words with no redundancy. All information is front-loaded and every word is necessary.

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

Completeness3/5

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

For a simple tool with one parameter and no output schema, the description adequately states the input forms but fails to describe the output or validation behavior. Without output schema, the agent lacks information about what to expect, making it incomplete.

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%, so baseline is 3. The description adds 'alias' as an accepted form beyond the schema's 'definition object or YAML/JSON string', providing minor additional value. However, it does not explain how to provide an alias or the expected format.

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 clearly states the verb 'validate' and the resource 'Spotlight ruleset', specifying acceptable forms (alias, definition object, or YAML/JSON string). This distinguishes it from sibling tools like lint_artifact, list_formats, and list_rulesets, which have different purposes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives. It does not state prerequisites, when validation is appropriate, or scenarios where another tool (e.g., lint_artifact) would be better.

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/api-commons/spotlight-mcp'

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