Skip to main content
Glama
api-commons

Spotlight MCP

by api-commons

lint_artifact

Lint API artifacts (OpenAPI, AsyncAPI, Arazzo) with Spotlight to identify governance issues. Returns findings with code, message, severity, and path.

Instructions

Lint an API artifact (OpenAPI, AsyncAPI, Arazzo, APIs.json, JSON Schema, …) with Spotlight and return governance findings (code, message, severity, path).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoArtifact format; selects the default ruleset when none is given.
contentYesThe API artifact as a YAML or JSON string.
rulesetNoA ruleset alias ("spotlight:oas") or a ruleset definition object. Defaults to the built-in ruleset for the format.
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses that the tool returns governance findings with specific fields (code, message, severity, path) and implies a read-only operation. However, it does not explicitly state that it does not modify data or mention rate limits or authentication needs.

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 a single, well-structured sentence that efficiently communicates purpose, supported artifact types, and return value fields. No unnecessary words.

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

Completeness4/5

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

The description is fairly complete given the tool's complexity: it explains the action, inputs types, and output structure. However, it could briefly mention error behavior or that the content must be parseable.

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?

The input schema has 100% coverage with descriptions for all parameters, so the baseline is 3. The description adds no additional meaning beyond what the schema provides.

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 lints API artifacts of various types and returns governance findings. It uses a specific verb (lint) and resource (API artifact), and the sibling tools are for listing formats, listing rulesets, and validating rulesets, so this tool is distinct.

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

Usage Guidelines3/5

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

The description implies when to use (to lint an artifact) but does not explicitly compare with sibling tools or mention when not to use it. No guidance on alternatives or prerequisites is provided.

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