checkyourself

Overview Schema Source Related Servers Discussions Admin

Scan Project

scan

Read-onlyIdempotent

Inspect a local project directory to detect production-readiness signals such as stack, scripts, CI, tests, env files, and secret risks, returning an evidence-based readiness score.

Instructions

Inspect a local project directory for deterministic production-readiness signals: stack, scripts, CI, tests, environment files, obvious secret/config risks, generated findings, counts, and public-repo claim guardrails. MCP mode returns JSON only; it does not write generated files or apply fixes. Requires no authentication. It reads local inputs only, does not make network calls, does not modify local files, and has no external rate limits.

Input Schema

TableJSON Schema

Name	Required	Description
`deep`	No	Run slower validation checks for detected surfaces, such as mutable GitHub Action references. Defaults to false.
`project`	No	Project root path to inspect, confined to CHECKYOURSELF_SCAN_ROOT (default: the MCP server process current directory).
`max_files`	No	Maximum files to scan before truncating (default 6000). The result reports skipped inputs and incompleteness in scan_limits.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedv0.1.2Sep 7, 2026

addedInput schema / additionalProperties
```
Added value: +false
```

changedInput schema / properties / deep / description

Previous value: -"Run slower validation checks for detected surfaces."New value: +"Run slower validation checks for detected surfaces, such as mutable GitHub Action references. Defaults to false."

addedInput schema / properties / max_files

Added value: +{
+  "description": "Maximum files to scan before truncating (default 6000). The result reports skipped inputs and incompleteness in scan_limits.",
+  "minimum": 1,
+  "type": "integer"
+}

changedInput schema / properties / project / description

Previous value: -"Project root path. Defaults to current directory."New value: +"Project root path to inspect, confined to CHECKYOURSELF_SCAN_ROOT (default: the MCP server process current directory)."

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "description": "Scan result using schema checkyourself-scan/1.",
+  "type": "object"
+}

First observedv0.1.0Jun 3, 2026

TDQS

A4.3/5.0

Behavior5/5

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

The description adds significant behavioral details beyond the annotations: it returns JSON only in MCP mode, does not write generated files or apply fixes, requires no authentication, reads local inputs only, makes no network calls, modifies no local files, and has no external rate limits. These disclosures exceed the readOnly/idempotent hints and give a clear operational picture.

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 compact yet information-dense, listing the key signals in a single sentence and then adding important constraints (JSON-only, no writes, no auth, no network) without unnecessary padding. The main purpose is front-loaded, and every sentence contributes to the agent's understanding.

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?

The description covers what the tool inspects, what it returns (findings, counts, guardrails), its mode of operation (JSON only, no writes/fixes), security context (no auth, no network), and limitations (max_files truncation handled in scan_limits). This is sufficient for an agent to decide when and how to invoke it, even without seeing the full output schema.

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 already provides 100% parameter coverage with descriptive text for each parameter (deep, project, max_files). The tool description does not add any additional parameter-specific meaning beyond what the schema states, so the baseline score of 3 applies.

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 states a specific action ('Inspect a local project directory') and a clear resource (local project) with a defined outcome (production-readiness signals). It lists concrete signals (stack, scripts, CI, tests, environment files, secret/config risks, findings, counts) that distinguish it from sibling tools like describe, score, or validate.

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 explains what the tool does and its non-destructive, local-only nature, but it does not explicitly contrast with sibling tools or state when to use this tool over alternatives. An agent can infer its niche from the listed signals, but the guidance is implicit rather than explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server