@certscore/mcp 0.2.12 → 0.2.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +151 -45
- package/dist/certscore-mcp.mjs +4377 -3997
- package/dist/index.js +1 -1
- package/dist/server.d.ts +42 -0
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +388 -124
- package/dist/tools.d.ts +43 -59
- package/dist/tools.d.ts.map +1 -1
- package/dist/tools.js +1303 -65
- package/package.json +13 -12
- package/server-light.json +21 -6
- package/server.json +2 -2
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
CertScore MCP exposes a focused Model Context Protocol server for CertScore Pulse workflows.
|
|
4
4
|
|
|
5
|
-
Status: public developer preview. Version 0.2.
|
|
5
|
+
Status: public developer preview. Version 0.2.16 makes confirmed Reject Path outcomes explicit through typed verdict and intentional-termination metadata, direct MCP TextContent, and separately scoped coverage limitations. Local WC01 development uses `pnpm mcp:certscore`.
|
|
6
6
|
|
|
7
7
|
Public docs:
|
|
8
8
|
|
|
@@ -10,22 +10,95 @@ Public docs:
|
|
|
10
10
|
- https://certscore.ai/developers/quickstart
|
|
11
11
|
- https://certscore.ai/developers/reference
|
|
12
12
|
- https://certscore.ai/api-pulse
|
|
13
|
+
- [MCP Light installation and agent reference](../../docs/mcp-light-install.md)
|
|
14
|
+
- [MCP Light marketplace workflow assets](../../docs/mcp-light-marketplace-assets.md)
|
|
15
|
+
|
|
16
|
+
## Light MCP — no authentication: start here
|
|
17
|
+
|
|
18
|
+
Light is the anonymous, no-auth Streamable HTTP endpoint for first-time and low-volume agent workflows:
|
|
19
|
+
|
|
20
|
+
```text
|
|
21
|
+
Light:
|
|
22
|
+
https://mcp.certscore.ai/mcp/light
|
|
23
|
+
|
|
24
|
+
Authentication: None
|
|
25
|
+
Tools: certscore_scan_site, certscore_get_scan_status, certscore_get_scan_bundle
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
No signup, API key, bearer token, browser login, or OAuth is required. Light allows up to 50 genuinely new scans per UTC day across the public Light surface and up to 5 per rolling 10 minutes, with additional IP/provider safeguards. Reused eligible results do not consume quota.
|
|
29
|
+
|
|
30
|
+
Light is a free website privacy scanner and cookie checker for public websites. It can return canonical evidence and findings for pre-consent cookies and storage, trackers and vendors, cookie banners, CMP and consent controls, privacy-policy and transparency surfaces, GDPR/ePrivacy and CCPA/CPRA review signals, and HTTPS/TLS transport observations. Typical uses include release privacy preflight, public vendor-domain review, landing-page tracker inspection, audit triage, and evidence collection before human privacy review.
|
|
31
|
+
|
|
32
|
+
Codex setup:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
codex mcp add certscore --url https://mcp.certscore.ai/mcp/light
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
First-run Codex prompt:
|
|
39
|
+
|
|
40
|
+
> Scan https://ergoveritas.com/.well-known/certscore-canary/sentinels/broad-baseline.html. If certscore_scan_site returns a queued, running, or finalizing result, retain the returned scanId and poll certscore_get_scan_status using scanId only. If certscore_scan_site returns a retryable error without a scanId, wait for retryAfterSeconds and retry certscore_scan_site; do not call certscore_get_scan_status until a scanId exists. Once the scan reaches a terminal status, call certscore_get_scan_bundle with detail=findings and maxBytes=8000. Summarize whether the result was new or reused, the score, risk level, findings, evidence links, coverage limitations, and report URL. Explain truncation or omitted sections when present. Treat results as automated public-web observations, not legal conclusions, certifications, or compliance determinations.
|
|
41
|
+
|
|
42
|
+
ErgoVeritas is a stable, owned canary site suited to demonstrating the complete scan, status, and bundle flow. Its pages intentionally contain test signals; users may substitute their own public HTTP or HTTPS URL for production-like testing.
|
|
43
|
+
|
|
44
|
+
Canonical Light workflow:
|
|
45
|
+
|
|
46
|
+
1. Call `certscore_scan_site` with a public URL.
|
|
47
|
+
2. If a retryable error has no `scanId`, wait `retryAfterSeconds` and retry `certscore_scan_site`.
|
|
48
|
+
3. If the result is queued, running, or finalizing, retain `scanId`.
|
|
49
|
+
4. Poll `certscore_get_scan_status` using `scanId` only. Never poll until `scanId` exists.
|
|
50
|
+
5. Stop polling at a terminal status, then call `certscore_get_scan_bundle`.
|
|
51
|
+
6. Use `detail=findings` for a compact finding review.
|
|
52
|
+
7. Use `detail=evidence` for evidence digests and references.
|
|
53
|
+
8. If truncated, follow `recommendedNextAction` or increase `maxBytes`.
|
|
54
|
+
9. Summarize findings together with coverage limitations and the report URL.
|
|
55
|
+
|
|
56
|
+
Recommended bundle budgets are `maxBytes=5000` for `summary`, `maxBytes=8000` for `findings`, `maxBytes=8000` for `evidence`, and `maxBytes=12000` to `25000` for `full`. MCP Light applies a 25,000-byte response ceiling so results remain within practical client limits; larger requested budgets are reported but clamped. At the 5,000-byte floor, compact core finding rows take priority over optional inventory and duplicate envelope fields. When repeated per-finding URLs are omitted, `evidenceUrlTemplate` points to `contentUrls.findings` and the returned finding ID so the same canonical evidence endpoint remains derivable. Inspect `canonicalFindingsComplete`, `requestedMaxBytes`, `effectiveMaxBytes`, `responseCeilingBytes`, `actualBytes`, `fullPayloadBytes`, `truncated`, `omittedSections`, `nextRecommendedMaxBytes`, and returned report or evidence content URLs. When `canonicalFindingsComplete` is true, retry only if omitted envelope detail is needed.
|
|
57
|
+
|
|
58
|
+
Verification prompt:
|
|
59
|
+
|
|
60
|
+
> List the available CertScore tools and confirm that certscore_scan_site, certscore_get_scan_status, and certscore_get_scan_bundle are available. Then scan https://ergoveritas.com/.well-known/certscore-canary/sentinels/broad-baseline.html and report whether the result was new or reused.
|
|
61
|
+
|
|
62
|
+
Success means the tool list contains exactly the three Light tools, no authorization page appears, and `certscore_scan_site` returns a stable `scanId` plus an explicit new-or-reused decision. An eligible reused result reports that quota was not consumed.
|
|
63
|
+
|
|
64
|
+
CertScore results are automated observations from a public-web scan. No-go, not-observed, and limited-coverage results are not proof of compliance, absence of risk, or legal status. Review the retained evidence and applicable context before relying on a finding.
|
|
65
|
+
|
|
66
|
+
Scans describe observable behavior at a point in time. Public sites may behave differently on later visits or in another execution context. CertScore findings and the CertScore score support human and agentic review; they are not legal advice, certification, or a compliance determination.
|
|
67
|
+
|
|
68
|
+
## Which MCP route should I use?
|
|
69
|
+
|
|
70
|
+
| Route | Access | Best for |
|
|
71
|
+
| --- | --- | --- |
|
|
72
|
+
| Light MCP — no authentication | No account, API key, bearer token, browser login, or OAuth; three tools; up to 50 new scans per UTC day across Light and 5 per rolling 10 minutes; eligible reuse is free | First-time users, testing, and discovery |
|
|
73
|
+
| Hosted MCP — OAuth | Hosted Streamable HTTP with OAuth scopes, higher volume, history, and approved advanced tools | Production, team, and managed remote clients |
|
|
74
|
+
| Local MCP — scoped API key | Local stdio with a scoped key and tools allowed by its scopes | Backend, local, and controlled automation workflows |
|
|
75
|
+
|
|
76
|
+
The full/authenticated Streamable HTTP endpoint is `https://mcp.certscore.ai/mcp`. Use it after Light when the workflow requires authentication, higher volume, history, or advanced tools. Core identifiers and canonical response fields remain compatible when moving from Light to authenticated access.
|
|
77
|
+
|
|
78
|
+
## Weighted read limits
|
|
79
|
+
|
|
80
|
+
MCP scan-resource reads use the same weighted, rolling policy as the direct CertScore API. Hosted MCP rejects an over-limit composite call before internal fan-out; local MCP receives the same protection from the underlying API. Poll only active status resources, stop at a terminal status, do not repeatedly retrieve terminal scan resources, and honor `Retry-After` before retrying. The current limits and weights are published at https://certscore.ai/developers/reference#read-rate-limits and in the `x-certscore-read-rate-policy` extension of the public OpenAPI documents.
|
|
13
81
|
|
|
14
82
|
## Tools
|
|
15
83
|
|
|
16
|
-
- `
|
|
17
|
-
- `
|
|
18
|
-
- `
|
|
19
|
-
- `
|
|
20
|
-
- `
|
|
21
|
-
- `
|
|
22
|
-
|
|
23
|
-
-
|
|
24
|
-
- `
|
|
25
|
-
- `
|
|
26
|
-
- `
|
|
27
|
-
- `
|
|
28
|
-
- `
|
|
84
|
+
- `certscore_scan_site` - Use CertScore.ai to scan a public website for observable privacy and consent signals, including pre-consent cookies and browser storage, third-party trackers, consent-banner and CMP behavior, TLS/transport security, privacy-policy disclosures, GDPR/ePrivacy transparency findings, and applicable CCPA/CPRA review signals. Starts or reuses a public-web scan with a 25-second total tool-call budget by default; scan creation time is deducted from completion waiting. If status is queued, running, or finalizing, retain scanId and poll certscore_get_scan_status using only that scanId. Stop polling at completed, completed_limited, failed, expired, or rate_limited. For usable completion, call certscore_get_scan_bundle. No-go and limited coverage are observations, never proof of compliance.
|
|
85
|
+
- `certscore_get_scan` - Retrieve the API v2 public-safe scan resource, including completed-limited no-go disposition, reason-specific guidance, and timing when available.
|
|
86
|
+
- `certscore_get_scan_status` - Poll with only the stable scanId returned by certscore_scan_site. Active responses include phase, heartbeat, estimated progress, stalled state, retry delay, and canonical scan provenance when available. Terminal responses include the CertScore score, risk, coverage, execution region (scanFrom), timestamps, report URL, and an explicit next action. For a reused or retrieved existing scan, use only persisted scanFrom and timestamps; never infer its original region from the current request, the user's location, or a default. Report unavailable provenance as unavailable. Stop polling at any terminal status.
|
|
87
|
+
- `certscore_get_report` - Focused follow-up: retrieve a bounded Pulse report with high-signal TextContent and typed structuredContent, including customer-safe no-go messaging. For broad privacy questions, use certscore_get_scan_bundle first because it combines canonical findings, limitations, and pre-consent rows without redundant calls.
|
|
88
|
+
- `certscore_get_evidence` - Focused follow-up: retrieve a bounded public-safe evidence packet with a concise TextContent digest and typed structuredContent. For broad privacy questions, use certscore_get_scan_bundle first. Excludes raw cookie values, raw bodies, sensitive payloads, full DOM, and unredacted query values.
|
|
89
|
+
- `certscore_get_scan_bundle` - Call after completed or completed_limited status. Every usable completed bundle returns a self-contained concise TextContent digest plus matching structuredContent, including canonical execution region (scanFrom) and timestamps when available. For a reused or retrieved existing scan, use only persisted scanFrom and timestamps; never infer its original region from the current request, the user's location, or a default, and report unavailable provenance as unavailable. The default summary includes the canonical report overview, up to five compact public-safe projected findings across the scan's observed domains, and bounded row-level pre-consent cookie/tracker evidence; detail=findings increases the default finding allowance, evidence adds bounded evidence digests and references, and full adds all available bounded sections. MCP Light applies a 25000-byte response ceiling so full results remain transport-safe; use returned content URLs when the complete requested tier exceeds it. At the 5000-byte floor, core finding rows take priority over optional inventory and duplicate envelope fields; evidenceUrlTemplate may replace repeated per-finding URLs while preserving their canonical derivation from contentUrls.findings and findingId. Every response declares finding and evidence total/returned/truncated counts, canonicalFindingsComplete, requested and effective byte budgets, the response ceiling, omittedSections, retrieval URLs, and nextRecommendedMaxBytes when the complete tier fits the ceiling. When canonicalFindingsComplete is true, retry only if omitted envelope detail is needed. Enumerate only returned observations and projected findings. Post-refusal observation may intentionally stop as soon as qualifying non-essential activity or a retained consent-signal contradiction is observed. A confirmed observation with termination.kind=evidence_satisfied is positive evidence for the returned observation, not an inconclusive Reject Path result; keep any coverageLimitations scoped to additional behavior or persistence that was not measured. Treat criticality, priority, and confidence as CertScore metadata; regulatory review lenses are non-determinative CertScore review context, not legal severity, legal exposure, or a compliance determination. Missing consent-action evidence does not establish Accept, Reject, or Decline behavior. Do not extrapolate observed embeds, vendors, or requests into unobserved cookies, fingerprinting, tracking, or processing. The CertScore score covers observable scan signals only; do not infer unobserved technologies or legal compliance status, and never interpret no-go, not-observed, or limited coverage as proof of compliance.
|
|
90
|
+
|
|
91
|
+
Post-refusal observation may intentionally stop after the first qualifying non-essential activity or retained consent-signal contradiction. A confirmed observation with `termination.kind=evidence_satisfied` is positive evidence for the returned observation, not an inconclusive Reject Path result. `coverageLimitations` describe only additional behavior or persistence that was not measured.
|
|
92
|
+
- `certscore_export_findings` - Return structured findings plus completed-limited no-go disposition and guidance for downstream review or ticketing workflows.
|
|
93
|
+
- `certscore_list_findings` - Focused follow-up: list bounded API v2 public-safe findings already projected by the canonical pipeline, with matching high-signal TextContent and typed structuredContent. For broad privacy questions, use certscore_get_scan_bundle first.
|
|
94
|
+
- `certscore_get_pre_consent_cookies_trackers` - Focused follow-up: retrieve bounded row-level public-safe pre-consent cookie/tracker evidence with matching TextContent and typed structuredContent. For a new broad request such as checking a site for pre-consent tracking, use certscore_scan_site then certscore_get_scan_bundle first.
|
|
95
|
+
- `certscore_explain_finding` - Explain one projected finding with public evidence, caveats, reviewer next steps, and reason-specific no-go context when applicable.
|
|
96
|
+
- `certscore_get_latest_domain_scan` - Retrieve the latest eligible API v2 public-safe scan for a domain.
|
|
97
|
+
|
|
98
|
+
Status provenance fields remain distinct: `provenance.retrievalMode` describes the current read, `provenance.creationDecision` reports the retained original new/reused decision or `unknown`, and `provenance.scanAgeSeconds` reports numeric age when available. A scan-ID lookup alone never proves reuse.
|
|
99
|
+
|
|
100
|
+
At tight bundle budgets, short canonical `nextStep` actions remain only when they fit without displacing a finding. Longer actions and evidence detail remain available through the returned canonical URLs or a larger complete tier.
|
|
101
|
+
- `certscore_get_latest_domain_pre_consent_cookies_trackers` - Focused follow-up: retrieve bounded row-level public-safe pre-consent cookie/tracker evidence from the latest eligible scan for a domain, with matching TextContent and typed structuredContent. For a broad current-site review, use certscore_scan_site then certscore_get_scan_bundle first.
|
|
29
102
|
|
|
30
103
|
The initial MCP surface intentionally does not include account scan browsing or scan comparison tools.
|
|
31
104
|
|
|
@@ -37,13 +110,38 @@ MCP tools backed by API v2 scan resources return scan timing when CertScore has
|
|
|
37
110
|
- `completedAt`
|
|
38
111
|
- `scanTimeSeconds`
|
|
39
112
|
|
|
40
|
-
This applies to `
|
|
113
|
+
This applies to `certscore_scan_site` when it returns an API v2 scan resource or job, `certscore_get_scan`, and `certscore_get_scan_status` when called with a `scanId`. `scanTimeSeconds: null` means timing is unavailable or incomplete and should not be displayed as `0`.
|
|
114
|
+
|
|
115
|
+
Completed Light results are canonical. `certscore_scan_site`, terminal `certscore_get_scan_status`, and `certscore_get_scan_bundle` return the same score, risk level, coverage, and timing fields. Scores include `scoreStatus`, `scoreVersion`, and `scoreUpdatedAt`; a scan remains `finalizing` until the persisted canonical report projection is ready, so a completed response always carries `scoreStatus: "final"`.
|
|
116
|
+
|
|
117
|
+
The value is labeled `CertScore score`, never a compliance score. It covers observable public-web scan signals only. Clients must not infer technologies absent from the returned evidence, compare the value with a hypothetical compliant baseline, or infer legal compliance status.
|
|
118
|
+
|
|
119
|
+
Every `failed`, `expired`, or `rate_limited` status includes a bounded `error` object with `code`, `message`, `retryable`, `retryAfterSeconds`, and `recommendedNextAction`.
|
|
120
|
+
|
|
121
|
+
## Light Bundle Detail and Byte Budgets
|
|
122
|
+
|
|
123
|
+
Every bundle declares its selected `detail` mode. `summary` returns the overview, canonical result, up to five compact projected finding objects, compact row-level pre-consent cookie/tracker evidence, coverage, limitations, counts, and report URL. This lets conversational MCP clients enumerate projected consent-control, CMP-context, transport, GDPR/ePrivacy transparency, social/media embed, accessibility, disclosure, and other returned review signals without needing a second tool; only categories actually present in canonical projections are returned. Findings and inventory sections each declare `total`, `returned`, and `truncated`. Each compact finding retains its public API v2 evidence anchor. Each inventory row includes cookie/tracker identity, cookie names where present, vendor, purpose, category, first-observed time, domains, evidence classification, and confidence. `findings` raises the default finding allowance to 20. `evidence` adds bounded evidence digests and references. `full` adds every available non-duplicated section subject to the effective byte budget; findings, top findings, and transport security are returned once in their canonical top-level bundle sections. When `fullPayloadBytes` exceeds the Light response ceiling, use the canonical content URLs instead of retrying above the ceiling.
|
|
124
|
+
|
|
125
|
+
`TextContent` is capped at 8,000 characters and uses short plain-text lines instead of large tables or nested JSON. It presents canonical overview facts and projected findings before the row inventory so one evidence family cannot crowd out the rest. The full profile's structured bundle defaults to 50,000 bytes and accepts a caller-selected 5,000-200,000-byte bound. Light defaults to and applies a 25,000-byte response ceiling. If either representation must omit returned items, it states that explicitly and preserves totals and truncation metadata.
|
|
126
|
+
|
|
127
|
+
`mcpMetadata` always includes `requestedMaxBytes`, `effectiveMaxBytes`, `responseCeilingBytes`, `responseBudgetClamped`, `actualBytes`, `fullPayloadBytes`, `truncated`, `canonicalFindingsComplete`, `truncationReason`, `omittedSections`, `deduplicatedSections`, `nextRecommendedMaxBytes`, `omittedContentAvailableViaUrl`, and `contentUrls`. Under byte pressure, optional detail and inventory rows are reduced before compact core finding rows. `canonicalFindingsComplete` separates complete projected findings from a partially omitted envelope. `nextRecommendedMaxBytes` is the rounded size needed for the complete requested tier rather than an incremental retry step; when the complete tier exceeds the MCP ceiling, the response directs the agent to an available report/evidence URL.
|
|
128
|
+
|
|
129
|
+
Input-validation errors remain MCP `-32602` errors and also include structured `invalid_arguments` details with the affected field and a safe next action. Error results use concise text plus machine-readable details. Successful results put the typed result in `structuredContent`; scan bundles also render a bounded row-level evidence summary in `TextContent` for client compatibility.
|
|
130
|
+
|
|
131
|
+
The Light workflow is:
|
|
132
|
+
|
|
133
|
+
1. Call `certscore_scan_site` with a public URL.
|
|
134
|
+
2. If a retryable error has no `scanId`, wait `retryAfterSeconds` and retry `certscore_scan_site`; do not poll.
|
|
135
|
+
3. If the result is queued, running, or finalizing, retain `scanId` and poll `certscore_get_scan_status` with only that ID.
|
|
136
|
+
4. Stop polling at any terminal status. For `completed` or `completed_limited`, call `certscore_get_scan_bundle`.
|
|
137
|
+
5. If the bundle is truncated, follow `recommendedNextAction`, increase `maxBytes`, or open a listed content URL.
|
|
138
|
+
6. Summarize the CertScore score, risk, pre-consent rows, findings, coverage, limitations, and report URL without treating no-go, not-observed, or limited coverage as proof of compliance.
|
|
41
139
|
|
|
42
140
|
## Completed-Limited No-Go Results
|
|
43
141
|
|
|
44
142
|
No-go scans are usable terminal results, not transport failures. Relevant tools retain `status: "completed_limited"`, `resultDisposition: "no_go"`, the stable reason code, customer-safe title and explanation, `limitationKind` attribution, retry guidance, and a bounded `evidenceExcerpt` when retained. Unknown future reasons use generic customer copy while remaining structured as `reasonCode: "unknown"`.
|
|
45
143
|
|
|
46
|
-
## Hosted
|
|
144
|
+
## Hosted MCP — OAuth
|
|
47
145
|
|
|
48
146
|
OAuth-capable MCP clients can connect to:
|
|
49
147
|
|
|
@@ -54,11 +152,11 @@ https://mcp.certscore.ai/mcp
|
|
|
54
152
|
Discovery endpoints:
|
|
55
153
|
|
|
56
154
|
```text
|
|
57
|
-
https://mcp.certscore.ai/.well-known/oauth-protected-resource
|
|
155
|
+
https://mcp.certscore.ai/.well-known/oauth-protected-resource/mcp
|
|
58
156
|
https://certscore.ai/.well-known/oauth-authorization-server
|
|
59
157
|
```
|
|
60
158
|
|
|
61
|
-
The hosted service uses OAuth authorization code with PKCE. Default read access requests `scan:read mcp
|
|
159
|
+
The full hosted service uses OAuth authorization code with PKCE. Default read access requests `scan:read mcp`. Active Trial workspaces connecting through Claude receive `scan:create` automatically, bounded to 20 genuinely new scans per hour and 100 per day per workspace; eligible recent-result reuse does not consume that allowance. Other clients continue to require an explicit scan-creation grant. The same tool implementation and output contracts power stdio and hosted transports.
|
|
62
160
|
|
|
63
161
|
For low-volume agent discovery without account or OAuth setup, use the unauthenticated endpoint:
|
|
64
162
|
|
|
@@ -66,17 +164,9 @@ For low-volume agent discovery without account or OAuth setup, use the unauthent
|
|
|
66
164
|
https://mcp.certscore.ai/mcp/anonymous
|
|
67
165
|
```
|
|
68
166
|
|
|
69
|
-
For the simplest no-account workflow, use
|
|
70
|
-
|
|
71
|
-
```text
|
|
72
|
-
https://mcp.certscore.ai/mcp/light
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
Light exposes only `scan_site`, `get_scan_status`, and `get_scan_bundle`. The allowance is 20 new scans per requester IP per UTC day.
|
|
76
|
-
Eligible recent-result reuse does not consume the allowance. Every no-account response includes the higher-volume contact path at
|
|
77
|
-
`support@certscore.ai`.
|
|
167
|
+
For the simplest no-account workflow, use the Light quickstart at the top of this document. OAuth metadata applies only to `https://mcp.certscore.ai/mcp`.
|
|
78
168
|
|
|
79
|
-
##
|
|
169
|
+
## Local MCP — scoped API key configuration
|
|
80
170
|
|
|
81
171
|
Install with Homebrew on macOS:
|
|
82
172
|
|
|
@@ -131,9 +221,9 @@ CERTSCORE_REQUEST_TIMEOUT_MS=300000
|
|
|
131
221
|
|
|
132
222
|
`CERTSCORE_API_KEY` should be a scoped CertScore API token for the workspace or preview user. The MCP server passes it to Pulse as a bearer token and does not persist it.
|
|
133
223
|
|
|
134
|
-
## API
|
|
224
|
+
## Local MCP — scoped API key access
|
|
135
225
|
|
|
136
|
-
Stdio API keys use `pulse:read` and `mcp`; creating scans additionally requires `pulse:scan`. Hosted OAuth uses `scan:read` and `mcp
|
|
226
|
+
Stdio API keys use `pulse:read` and `mcp`; creating scans additionally requires `pulse:scan`. Hosted OAuth uses `scan:read` and `mcp`. Active Trial workspaces connecting through Claude receive bounded `scan:create` automatically; other clients can request scan-creation access by emailing `support@certscore.ai` with the organization, MCP client, expected workflow, expected request volume, and contact email.
|
|
137
227
|
|
|
138
228
|
## Verify Install
|
|
139
229
|
|
|
@@ -153,7 +243,7 @@ Agents that cannot create an account or configure OAuth can use the public API v
|
|
|
153
243
|
```bash
|
|
154
244
|
curl -X POST https://certscore.ai/api/v2/scans \
|
|
155
245
|
-H "Content-Type: application/json" \
|
|
156
|
-
-d '{"url":"https://
|
|
246
|
+
-d '{"url":"https://ergoveritas.com/.well-known/certscore-canary/sentinels/broad-baseline.html","freshness":"latest","scanFrom":"eu_ie"}'
|
|
157
247
|
```
|
|
158
248
|
|
|
159
249
|
New anonymous scans are limited to 20 per requester IP per UTC day. Reusing an eligible recent result does not consume the quota. Poll the returned status resource, then retrieve findings or evidence. Contact `support@certscore.ai` for a higher-volume allowance, including when reuse serves the current request.
|
|
@@ -228,20 +318,28 @@ Local repo config for contributors:
|
|
|
228
318
|
|
|
229
319
|
## Agent Workflow
|
|
230
320
|
|
|
231
|
-
1. Call `
|
|
232
|
-
2. Only if it returns a non-terminal job, call `
|
|
233
|
-
3.
|
|
234
|
-
4.
|
|
235
|
-
5.
|
|
236
|
-
6. Call `get_latest_domain_scan` or `get_latest_domain_pre_consent_cookies_trackers` when the user asks for latest eligible public data for a domain.
|
|
321
|
+
1. Call `certscore_scan_site` with a public URL. It normally returns the completed scan resource in the same tool call.
|
|
322
|
+
2. Only if it returns a non-terminal job, call `certscore_get_scan_status` using the stable `scanId` until completion.
|
|
323
|
+
3. If status is `queued`, `running`, or `finalizing`, retain the returned `scanId` and poll `certscore_get_scan_status` using only that ID. Stop polling at `completed`, `completed_limited`, `failed`, `expired`, or `rate_limited`.
|
|
324
|
+
4. For `completed` or `completed_limited`, call `certscore_get_scan_bundle` with its default `detail: "summary"`. Use `findings`, `evidence`, or `full` only when progressively deeper bounded context is required.
|
|
325
|
+
5. Summarize the canonical score, risk, findings, coverage, limitations, report URL, and next action. Never treat no-go, not-observed, or limited coverage as proof of compliance.
|
|
237
326
|
|
|
238
|
-
|
|
327
|
+
Canonical first-run prompt:
|
|
328
|
+
|
|
329
|
+
> Scan these public URLs. For each one, call certscore_scan_site. If status is queued, running, or finalizing, retain scanId and poll certscore_get_scan_status using only scanId. Stop polling at completed, completed_limited, failed, expired, or rate_limited. For completed or completed_limited scans, call certscore_get_scan_bundle with detail=findings. If truncated, follow recommendedNextAction or increase maxBytes. Report the canonical score, risk level, coverage, findings, limitations, report URL, and next action. Never treat no-go, not-observed, or limited coverage as proof of compliance.
|
|
330
|
+
4. Call `certscore_get_report`, `certscore_get_evidence`, `certscore_list_findings`, or `certscore_get_pre_consent_cookies_trackers` only when the task needs a dedicated view.
|
|
331
|
+
5. Call `certscore_explain_finding` when a reviewer needs evidence and caveats for a specific finding.
|
|
332
|
+
6. Call `certscore_get_latest_domain_scan` or `certscore_get_latest_domain_pre_consent_cookies_trackers` when the user asks for latest eligible public data for a domain.
|
|
333
|
+
|
|
334
|
+
`certscore_scan_site` reports whether the result was reused, why the freshness decision was made, whether anonymous quota was consumed, the remaining daily allowance, the UTC reset time, and the recommended next tool.
|
|
239
335
|
|
|
240
336
|
With `freshness: "latest"`, CertScore reuses an eligible scan completed within the last 24 hours for the same normalized target and scan region. A reusable result must have completed usable page coverage and must not be an early-loss, no-page, or otherwise non-reusable limited result. Reuse does not consume anonymous quota. `freshnessDecision` states whether a recent result was reused or a new scan was queued; `reusedScanAgeSeconds` reports the reused result's age.
|
|
241
337
|
|
|
338
|
+
Provenance keeps the current retrieval separate from the original creation decision. `retrievalMode=creation_response` means the result came from `certscore_scan_site`; `retrievalMode=scan_id_lookup` means a later tool fetched the retained scan by ID. `creationDecision` is `new_scan` or `reused_scan` only when the response retains that fact, and otherwise is `unknown`. Do not translate `scan_id_lookup` into a reused-scan claim. `scanAgeSeconds` reports a nonnegative age when a retained age or completion timestamp is available.
|
|
339
|
+
|
|
242
340
|
```json
|
|
243
341
|
{
|
|
244
|
-
"tool": "
|
|
342
|
+
"tool": "certscore_get_pre_consent_cookies_trackers",
|
|
245
343
|
"arguments": {
|
|
246
344
|
"scanId": "00000000-0000-4000-8000-000000000123"
|
|
247
345
|
}
|
|
@@ -250,16 +348,16 @@ With `freshness: "latest"`, CertScore reuses an eligible scan completed within t
|
|
|
250
348
|
|
|
251
349
|
```json
|
|
252
350
|
{
|
|
253
|
-
"tool": "
|
|
351
|
+
"tool": "certscore_get_latest_domain_pre_consent_cookies_trackers",
|
|
254
352
|
"arguments": {
|
|
255
|
-
"domain": "
|
|
353
|
+
"domain": "ergoveritas.com",
|
|
256
354
|
"scanFrom": "eu_ie"
|
|
257
355
|
}
|
|
258
356
|
}
|
|
259
357
|
```
|
|
260
358
|
|
|
261
359
|
When summarizing table data, group rows by `vendor`, `purpose`, and `host` unless the user asks for row-level JSON.
|
|
262
|
-
Treat MCP outputs as automated public-web observations for review. They are not legal advice, certification, or a compliance determination. MCP tools must not infer findings from raw labels, raw network events, missing data, or display-only context.
|
|
360
|
+
Treat MCP outputs as automated public-web observations for human and agentic review. They are not legal advice, certification, or a compliance determination. MCP tools must not infer findings from raw labels, raw network events, missing data, or display-only context.
|
|
263
361
|
|
|
264
362
|
## Live Smoke
|
|
265
363
|
|
|
@@ -270,7 +368,7 @@ CERTSCORE_API_KEY=... pnpm mcp:certscore:smoke
|
|
|
270
368
|
Optional:
|
|
271
369
|
|
|
272
370
|
```bash
|
|
273
|
-
CERTSCORE_MCP_SMOKE_URL=https://
|
|
371
|
+
CERTSCORE_MCP_SMOKE_URL=https://ergoveritas.com/.well-known/certscore-canary/sentinels/broad-baseline.html
|
|
274
372
|
```
|
|
275
373
|
|
|
276
374
|
Without `CERTSCORE_API_KEY`, the smoke script exits successfully with a skip message.
|
|
@@ -278,13 +376,21 @@ Without `CERTSCORE_API_KEY`, the smoke script exits successfully with a skip mes
|
|
|
278
376
|
For the full production operator smoke, run from the WC01 repo:
|
|
279
377
|
|
|
280
378
|
```bash
|
|
281
|
-
pnpm ops:smoke:mcp-production
|
|
379
|
+
CERTSCORE_ALLOW_PAID_ECS_SMOKE=1 pnpm ops:smoke:mcp-cli-production
|
|
282
380
|
```
|
|
283
381
|
|
|
284
|
-
This verifies the Homebrew-installed `certscore-mcp` command against live `https://certscore.ai`. It creates a short-lived preview key, stores only the hash in production through the approved ECS/Fargate path, checks required tools,
|
|
382
|
+
This verifies the Homebrew-installed `certscore-mcp` command against live `https://certscore.ai`. It first requires the installed CLI version to match the workspace version, then creates a short-lived preview key, stores only the hash in production through the approved ECS/Fargate path, checks required tools, requires non-empty findings and pre-consent cookies/trackers rows, and revokes the temporary key afterward. The explicit cost opt-in is required because this separate CLI check starts one-off Fargate tasks. Use `pnpm ops:smoke:mcp-production` for the hosted, retained-scan, read-only canary.
|
|
285
383
|
|
|
286
384
|
## Troubleshooting
|
|
287
385
|
|
|
386
|
+
- Unexpected OAuth in Codex: remove the server and add it again with the exact Light URL `https://mcp.certscore.ai/mcp/light`. Do not configure a bearer token.
|
|
387
|
+
- Successful Light connection: Streamable HTTP initialization completes, no authorization page opens, and `tools/list` returns exactly `certscore_scan_site`, `certscore_get_scan_status`, and `certscore_get_scan_bundle`.
|
|
388
|
+
- Missing scan ID: retry `certscore_scan_site` only when the error is retryable. Never call `certscore_get_scan_status` until `scanId` exists.
|
|
389
|
+
- Rate limited: follow `retryAfterSeconds` and `recommendedNextAction`, wait for the returned UTC reset, or reuse an eligible result.
|
|
390
|
+
- Reused result: report that the eligible prior scan was reused and quota was not consumed.
|
|
391
|
+
- Truncated bundle: first inspect `canonicalFindingsComplete`; when true, retry only for omitted envelope detail. Otherwise follow `nextRecommendedMaxBytes`, raise `maxBytes`, or open a returned report or evidence content URL.
|
|
392
|
+
- Invalid URL: correct the field named by the structured `invalid_arguments` response and retry with a public HTTP or HTTPS URL.
|
|
393
|
+
- Limited result versus failure: `completed_limited`, no-go, not-observed, and limited coverage are observations only, never proof of compliance. `failed`, `expired`, and connection errors are failures with retry guidance.
|
|
288
394
|
- Command not found: run the Homebrew install again and confirm Homebrew's bin directory is on `PATH`.
|
|
289
395
|
- Missing API key: set `CERTSCORE_API_KEY` in the MCP client environment and rerun `certscore-mcp doctor`.
|
|
290
396
|
- Bad token: rotate the key or request a scoped API/MCP key from `support@certscore.ai`.
|