coral-review-source-spec

Review Coral source manifests for quality and consistency standards.

4|3|Updated Apr 6, 2026
One-click install
npx skills add https://github.com/withcoral/skills --skill coral-review-source-spec
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: coral-review-source-spec
Source: https://github.com/withcoral/skills/tree/main/coral-review-source-spec
Command: npx skills add https://github.com/withcoral/skills --skill coral-review-source-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents poorly documented or inconsistent Coral source specs from reaching users by ensuring proposed source changes meet product and query-experience standards.

Core Features & Use Cases

  • Product-focused review: Evaluates whether a source spec is understandable, safe, and useful to Coral users and agents, not just whether it passes CI.
  • Consistency and ergonomics checks: Compares the proposed source’s patterns, naming, inputs/auth modeling, and query/table design against existing Coral sources.
  • Review output ready for iteration: Produces a code-review style result with prioritized findings, file/line references, and clear open questions when needed.

Quick Start

Use coral-review-source-spec to review the updated sources/community/acme/my_source/manifest.yaml and confirm it matches Coral’s style, auth/input conventions, and table/query ergonomics.

Frequently Asked Questions about coral-review-source-spec

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a YAML manifest for code and documentation quality?

To review a YAML manifest for quality, run an automated source spec review that evaluates product fit, YAML correctness, and query ergonomics. This process inspects auth and input modeling, pagination, and HTTP semantics to ensure your manifest meets consistency standards.

What is a Coral source spec and when do I need to review it?

A Coral source spec is a YAML manifest defining how data sources connect and behave. You need to review it when a pull request adds or modifies source directories under sources/core or sources/community to prevent poorly documented sources from reaching users.

How do I check if my source manifest handles auth and inputs correctly?

To check auth and input correctness in your source manifest, review the secret versus variable handling directly in the YAML configuration. A source spec review validates this modeling against established conventions to ensure safe and consistent authentication.

Can I use automated review for pull requests that modify community source directories?

Yes, you can use a source spec review for pull requests that modify community source directories. It evaluates the updated manifest.yaml against product standards, naming patterns, and table design to produce prioritized findings with specific file and line references.

What's the best way to validate query ergonomics and pagination in a data source manifest?

The best way to validate query ergonomics and pagination is to run a source spec review that compares your proposed source patterns against existing sources. It enforces HTTP semantics and query design guidance to ensure the data source is useful to agents.

Why does my source spec pass CI but still fail quality standards?

Your source spec may pass CI but fail quality standards because CI only checks syntax, while source spec review evaluates whether the source is understandable, safe, and useful to users. It enforces documentation quality, naming consistency, and query ergonomics beyond basic validation.