Skip to main content
Glama
api-commons

Spotlight MCP

by api-commons

list_rulesets

List the built-in Spotlight rulesets for OpenAPI, AsyncAPI, and Arazzo, along with the rules contained in each.

Instructions

List the built-in Spotlight rulesets (spotlight:oas, spotlight:asyncapi, spotlight:arazzo) and the rules each contains.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

With no annotations, the description carries full burden. 'List' implies a read-only operation, but it does not explicitly state no side effects or authentication needs. The behavior is simple, so a score of 3 is adequate.

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 with no waste. Front-loaded with key verb and resource, efficiently conveying purpose and scope.

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 parameterless tool with no output schema, the description fully explains what it does and what it returns (rulesets and their rules). No gaps given the simplicity.

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 tool has zero parameters, and the description does not need to add parameter meaning. According to guidelines, baseline is 4 for 0 parameters.

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 tool lists built-in Spotlight rulesets and their rules, naming specific examples (spotlight:oas, etc.). It distinguishes from siblings like lint_artifact (linting) and list_formats (formats) by focusing on rulesets.

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?

The description implies use when needing to see available rulesets. While no explicit exclusions or alternatives are given, the context of sibling tools and the specific verb 'list' provide clear usage context.

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