{
  "markdown": "# ReadyOrAI\n\nZero-cost MCP server for local code inspection. Analyzes your code for clean code practices, best practices, and gives actionable recommendations — without modifying your code or making API calls.\n\n## Features\n\n- **9 analyzers**: complexity, naming, structure, patterns, imports, documentation, security, duplication, AI-generated code detection\n- **Multi-language**: JS/TS, Python, Go, Rust (deep analysis) + Java, C#, Ruby, PHP, and more (regex-based)\n- **Zero-cost**: All analysis runs locally — no API keys, no external calls\n- **MCP server**: Works with Claude Desktop, Claude Code, and VS Code via stdio transport\n- **CLI tool**: `ready @filename` and `AI` terminal commands for standalone use\n- **SARIF output**: Export results for GitHub Code Scanning integration\n- **Watch mode**: Continuous re-analysis on file changes\n- **Baseline/diff mode**: Track incremental adoption — only see new issues\n- **Config file**: Project-level `.readyorai.json` for shared settings\n- **Inline suppressions**: Silence specific findings with `// readyorai-ignore` comments\n\n## Installation\n\n### As an MCP Server\n\n**Claude Desktop** (`claude_desktop_config.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"readyorai\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"readyorai\"]\n    }\n  }\n}\n```\n\n**Claude Code**:\n\n```bash\nclaude mcp add readyorai -- npx -y readyorai\n```\n\n**VS Code** (`.vscode/mcp.json`):\n\n```json\n{\n  \"servers\": {\n    \"readyorai\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"readyorai\"]\n    }\n  }\n}\n```\n\n### As a CLI Tool\n\n```bash\nnpm install -g readyorai\n```\n\n## CLI Usage\n\n```bash\nready @src/index.ts                          # Inspect a single file\nready @src/                                  # Inspect a directory\nready @src/index.ts --checks security,naming # Run specific checks\nready @src/index.ts --json                   # JSON output\nready @src/index.ts --sarif                  # SARIF output (GitHub Code Scanning)\nready @src/index.ts --severity warning       # Only warnings and errors\nready @src/index.ts --watch                  # Re-analyze on file changes\nready @src/ --baseline baseline.json         # Compare against saved baseline\nready @src/ --save-baseline baseline.json    # Save current results as baseline\nAI                                           # Inspect current directory\nAI @src/utils.ts                             # Alias with file target\n```\n\n### Exit Codes\n\n| Code | Meaning |\n|------|---------|\n| `0` | No issues found |\n| `1` | Warnings found |\n| `2` | Errors found |\n| `3` | Runtime error |\n\n## Configuration\n\nCreate a `.readyorai.json` in your project root:\n\n```json\n{\n  \"checks\": [\"complexity\", \"naming\", \"security\"],\n  \"severity\": \"warning\",\n  \"exclude\": [\"dist/**\", \"node_modules/**\"]\n}\n```\n\n### Inline Suppressions\n\nSilence specific findings on a line:\n\n```js\neval(code); // readyorai-ignore\n```\n\n## MCP Tools\n\n| Tool | Description |\n|------|-------------|\n| `inspect_file` | Analyze a single file for code quality issues |\n| `inspect_directory` | Batch analysis of all source files in a directory |\n| `get_metrics` | Get quantitative metrics (LOC, complexity, function count) |\n| `compare_files` | Compare two file versions and show fixed, introduced, or unchanged findings |\n| `suggest_fixes` | Get actionable fix suggestions with context for each finding |\n\n## MCP Prompts\n\n| Prompt | Description |\n|--------|-------------|\n| `review-code` | Structured code review with optional focus area |\n| `health-check` | Project-level health assessment |\n\n## Checks\n\n| Check | What it detects |\n|-------|----------------|\n| `complexity` | Cyclomatic/cognitive complexity, deep nesting |\n| `naming` | Convention violations, single-letter vars, boolean prefixes |\n| `structure` | Long files/functions, too many parameters, long lines |\n| `patterns` | console.log, empty catch, magic numbers, nested ternaries, TODOs |\n| `imports` | Unused imports, wildcard imports, scattered imports |\n| `documentation` | Missing JSDoc/docstrings, low comment ratio |\n| `security` | Hardcoded secrets, eval(), SQL injection, XSS patterns |\n| `duplication` | Duplicate code blocks, repeated magic strings |\n| `ai-detection` | Detects patterns common in AI-generated code |\n\n## Language Support\n\n| Tier | Languages | Analysis |\n|------|-----------|----------|\n| 1 | JavaScript, TypeScript, Python, Go, Rust | Full AST-powered analysis |\n| 2 | Java, C#, Ruby, PHP, Swift, Kotlin, C, C++ | Regex + heuristic analysis |\n| 3 | Any text file | Line-based checks (length, TODOs, secrets, duplication) |\n\n## Development\n\n```bash\ngit clone https://github.com/TedoNeObichaJavaScript/ReadyOrAI.git\ncd ReadyOrAI\nnpm install\nnpm run build\nnpm test\n```\n\n## Support\n\nIf you find ReadyOrAI useful, consider supporting the project:\n\n- **Borko** — 5 euro\n\n## License\n\nMIT\n",
  "bytes": 4791,
  "sha": "b2d47183a89dcd0963bc07d629f0a8d9ab5008a7763a7c3430b60d3937cdd954",
  "repo_slug": "tedoneobichajavascript/readyorai",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_tedoneobichajavascript_readyor_a6ea018b/readme"
}