Coral Review Source Spec

Coral Review Source Spec

Review Goal

Review the source as product surface. Do not spend the review mainly restating CI, schema validation, or YAML lint results unless those failures are visible and relevant. Focus on whether the source will be understandable, useful, safe, and consistent for Coral users and agents.

Workflow

1. Identify the target source directory or PR changes.
   • For a path request, inspect manifest.yaml, any README, and related source docs or tests.
   • For a PR request, find changed files under sources/core/ or sources/community/. If the PR does not add or update a source, say the skill is not applicable and review normally.
2. Read guidance in the Coral repo before judging style:
   • CONTRIBUTING.md, especially "Source contributions".
   • The repo AGENTS.md and any nearer AGENTS.md.
   • Similar existing sources in sources/core/ and the community example in sources/community/hn/.
3. Compare against existing source patterns, not a generic API-wrapper ideal. Look at nearby sources with similar shape: public no-auth APIs, token APIs, OAuth-backed APIs, GraphQL APIs, search-heavy APIs, log/time-series APIs, or generated large API sources.
4. Produce a code-review style result: findings first, ordered by severity, with file and line references. Include open questions only after findings. If there are no substantive issues, say so and mention residual risks or review gaps.

Review Checklist

These checks should be based on the authoritative API docs for the API the source exposes.

Scope and Fit

• Source belongs in the right tree: sources/community/ for community sources; new sources/core/ additions need prior discussion per CONTRIBUTING.md. PRs from external contributors should almost always be in sources/community.
• If reviewing a new source, ensure it doesn't replicate the functionality of an existing source.
• Source name is clear, stable, lowercase, and matches the SQL schema users will type.
• Scope is narrow enough to be coherent. A small source should expose the main user workflows, not every marginal endpoint.
• No real credentials, customer data, internal fixtures, or private URLs are committed.
• Updated sources bump version when user-visible behavior, tables, columns, inputs, or semantics change.

Setup and Documentation

• Top-level description says what a user can query, not just what vendor API is wrapped.
• inputs distinguish secrets from variables correctly, use clear environment-style names, and include enough hints for first success. Environment-style names are prefixed with a service-specific prefix (e.g. GITHUB_API_TOKEN, not API_TOKEN.)
• Treat credential-like inputs as secrets, regardless of read-only scope or optional auth mode. Inputs named or described as API_KEY, TOKEN, ACCESS_TOKEN, PASSWORD, SECRET, APPLICATION_KEY, READ_KEY, ADMIN_KEY, private keys, bearer values, or authorization header values must be kind: secret; endpoint/base URL/site/region/domain/org/account/user/email values may be kind: variable.
• Do not make a credential a variable with an empty default to simulate optional authentication. For the current source-spec surface, require the secret or call out the missing optional-auth design explicitly; never expose a token just to support anonymous installs.
• Auth docs mention required token type, scopes or permissions, and where to get credentials.
• If a secret declares credential.methods, each method matches the provider's supported setup path. OAuth methods use device-code, authorization-code, or client-credentials flow. Authorization-code methods need an explicit pkce value, loopback redirect URI, correct redirect port mode, and support for SSH, VM, and split-browser setups where the CLI accepts a pasted final localhost redirect URL while waiting for the loopback callback. Device-code methods need device_authorization_url, no redirect URI fields, and no static client secret. Client-credentials methods need token_url, client.id.input, client.secret.input, and client.secret.transport, with no redirect URI fields, authorization endpoints, device authorization endpoints, PKCE, or Dynamic Client Registration. All OAuth methods need correct endpoint URLs, appropriate client ID/default/input behavior, correct client-secret transport when applicable, and least-privilege scopes. For authorization-code or device-code Dynamic Client Registration, Coral always registers a native client, source specs cannot configure a web application type, and request_refresh_token_grant: true should appear only when the provider supports registering refresh-token grants. OAuth-protected Streamable HTTP MCP sources include oauth.resource when the provider requires resource indicators. OAuth URL templates may reference only declared kind: variable inputs for non-secret URL components.
• OAuth methods do not replace runtime auth. The stored secret is still referenced by auth, request headers, query params, or body fields where the provider expects it.
• OAuth setup docs tell users whether they need their own OAuth client, which redirect URI to register when applicable, which scopes to grant, and any provider/client settings required to issue refresh tokens. Client-credentials methods can rely on re-minting short-lived access tokens only when the provider returns usable expires_in metadata; otherwise users must reconnect after the token expires. Other methods whose provider will not issue refresh tokens should also call out that users must reconnect when access tokens expire.
• When both OAuth and pasted-token setup are supported, the method ordering and labels make the preferred path obvious, usually OAuth first and source_config fallback second.
• Non-trivial sources include README or manifest guides with setup, schema orientation, and example queries.
• Behavior changes, setup changes, source semantics, and examples are documented in the same PR.

Query Ergonomics

• Tables model useful user concepts: dimension tables such as users, projects, channels, services, teams, repositories, or metadata are easy starting points.
• High-cardinality or expensive endpoints require filters or have conservative fetch_limit_default values.
• Required filters are explicit and described in table description or guide.
• Guides tell users how to start, which IDs to join through, and any provider-specific timestamp or query syntax traps.
• Provider endpoints that accept query text and return ranked candidates use kind: search table functions with search_limits, stable result identifiers, and useful candidate metadata. Non-retrieval table functions keep the default kind for parameterized operations such as scoped child collections, time-range logs, metrics queries, or detail operations. Ordinary table filters are for exact lookup, scoping, or provider-side filtering; mode: contains is only substring matching. Flag provider-native search modeled as a filter and require a kind: search function.
• Table, table-function, and column names are snake_case, stable, and obvious. Table and table-function names must be unique within the source's case-insensitive relation namespace. Table-function names must use SQL identifier syntax: start with an ASCII letter or underscore, then use only ASCII letters, numbers, or underscores. Prefer plain snake_case table names; quoted SQL table names are valid for compatibility but should not leak odd provider operation names unless the source is intentionally generated.

HTTP and API Semantics

• base_url and input-derived URLs handle hosted, cloud, region, or enterprise variants without making the common case painful.
• Auth headers and request headers match provider expectations, including API version or Accept headers when needed.
• Pagination mode, cursor paths, page size limits, and result paths reflect the actual API response, not a guessed pattern.
• ok_path, error_path, allow_404_empty, and rate-limit hints are present when the provider's API behavior needs them.
• Required API permissions are not broader than needed for the exposed read-only surface.

Column Design

• Columns preserve stable identifiers and include human-readable names where available.
• Opaque IDs and very large numeric IDs are usually Utf8; use numeric types for values users should compare or aggregate numerically.
• Timestamp columns are exposed for important times when Coral can reliably parse or derive them; keep raw provider timestamp fields only when useful.
• nullable matches provider reality. Do not mark fields non-null just because examples happened to contain them.
• Nested objects are flattened only when the fields are broadly useful; otherwise expose JSON/text columns rather than creating brittle, low-value columns.
• Column descriptions are concise and user-facing.

Style Consistency

• YAML is readable and follows existing manifest ordering: identity, inputs/auth/base URL, test queries, functions/tables.
• Existing core sources use short table descriptions plus guide blocks for usage advice; prefer that split.
• README structure, when present, should resemble existing source READMEs: authentication, rate limits when relevant, table categories or schema overview, and examples.
• Wording should be clear to a new user. Avoid internal Coral implementation terms unless they are part of the user-facing source-spec surface.

Output Shape

Lead with concrete findings. Use severity labels only when helpful, but do not bury issues under a summary. Prefer:

Findings
- High: `sources/community/foo/manifest.yaml:42` marks `created_at` non-null, but the provider omits it for imported records...
- Medium: `sources/community/foo/README.md:18` shows setup but never states the required token scope...

Open questions
- Is endpoint X intentionally omitted from the first version?

Review notes
- I treated CI lint/schema checks as out of scope unless visible in the diff.

If no issues are found, say that directly and include any limits, such as not having live credentials or not inspecting CI logs.

When highlighting a discrepancy between the source and the API documentation, always include links to the exact API documentation page.