English Français العربية

io.github.TedoNeObichaJavaScript/readyorai

السجل الرسمي أدوات المطورين

Zero-cost MCP server for local code inspection and best-practice recommendations

الشيفرة المصدرية التوثيق

ماذا يمكنك أن تفعل مع io.github.TedoNeObichaJavaScript/readyorai؟

  • 9 analyzers: complexity, naming, structure, patterns, imports, documentation, security, duplication, AI-generated code detection
  • Multi-language: JS/TS, Python, Go, Rust (deep analysis) + Java, C#, Ruby, PHP, and more (regex-based)
  • Zero-cost: All analysis runs locally — no API keys, no external calls
  • MCP server: Works with Claude Desktop, Claude Code, and VS Code via stdio transport
  • CLI tool: ready @filename and AI terminal commands for standalone use
  • SARIF output: Export results for GitHub Code Scanning integration
  • Watch mode: Continuous re-analysis on file changes
  • Baseline/diff mode: Track incremental adoption — only see new issues

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package readyorai
Claude Code 
claude mcp add readyorai -- npx -y readyorai@0.1.2
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "readyorai": {
            "command": "npx",
            "args": [
                "-y",
                "readyorai@0.1.2"
            ]
        }
    }
}

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. ReadyOrAI
  2. Features
  3. Installation
  4. CLI Usage
  5. Configuration
  6. MCP Tools
  7. MCP Prompts
  8. Checks
  9. Language Support
  10. Development
  11. Support
  12. License

ReadyOrAI

Zero-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.

Features

  • 9 analyzers: complexity, naming, structure, patterns, imports, documentation, security, duplication, AI-generated code detection
  • Multi-language: JS/TS, Python, Go, Rust (deep analysis) + Java, C#, Ruby, PHP, and more (regex-based)
  • Zero-cost: All analysis runs locally — no API keys, no external calls
  • MCP server: Works with Claude Desktop, Claude Code, and VS Code via stdio transport
  • CLI tool: ready @filename and AI terminal commands for standalone use
  • SARIF output: Export results for GitHub Code Scanning integration
  • Watch mode: Continuous re-analysis on file changes
  • Baseline/diff mode: Track incremental adoption — only see new issues
  • Config file: Project-level .readyorai.json for shared settings
  • Inline suppressions: Silence specific findings with // readyorai-ignore comments

Installation

As an MCP Server

Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "readyorai": {
      "command": "npx",
      "args": ["-y", "readyorai"]
    }
  }
}

Claude Code:

claude mcp add readyorai -- npx -y readyorai

VS Code (.vscode/mcp.json):

{
  "servers": {
    "readyorai": {
      "command": "npx",
      "args": ["-y", "readyorai"]
    }
  }
}
As a CLI Tool
npm install -g readyorai

CLI Usage

ready @src/index.ts                          # Inspect a single file
ready @src/                                  # Inspect a directory
ready @src/index.ts --checks security,naming # Run specific checks
ready @src/index.ts --json                   # JSON output
ready @src/index.ts --sarif                  # SARIF output (GitHub Code Scanning)
ready @src/index.ts --severity warning       # Only warnings and errors
ready @src/index.ts --watch                  # Re-analyze on file changes
ready @src/ --baseline baseline.json         # Compare against saved baseline
ready @src/ --save-baseline baseline.json    # Save current results as baseline
AI                                           # Inspect current directory
AI @src/utils.ts                             # Alias with file target
Exit Codes
CodeMeaning
0No issues found
1Warnings found
2Errors found
3Runtime error

Configuration

Create a .readyorai.json in your project root:

{
  "checks": ["complexity", "naming", "security"],
  "severity": "warning",
  "exclude": ["dist/**", "node_modules/**"]
}
Inline Suppressions

Silence specific findings on a line:

eval(code); // readyorai-ignore

MCP Tools

ToolDescription
inspect_fileAnalyze a single file for code quality issues
inspect_directoryBatch analysis of all source files in a directory
get_metricsGet quantitative metrics (LOC, complexity, function count)
compare_filesCompare two file versions and show fixed, introduced, or unchanged findings
suggest_fixesGet actionable fix suggestions with context for each finding

MCP Prompts

PromptDescription
review-codeStructured code review with optional focus area
health-checkProject-level health assessment

Checks

CheckWhat it detects
complexityCyclomatic/cognitive complexity, deep nesting
namingConvention violations, single-letter vars, boolean prefixes
structureLong files/functions, too many parameters, long lines
patternsconsole.log, empty catch, magic numbers, nested ternaries, TODOs
importsUnused imports, wildcard imports, scattered imports
documentationMissing JSDoc/docstrings, low comment ratio
securityHardcoded secrets, eval(), SQL injection, XSS patterns
duplicationDuplicate code blocks, repeated magic strings
ai-detectionDetects patterns common in AI-generated code

Language Support

TierLanguagesAnalysis
1JavaScript, TypeScript, Python, Go, RustFull AST-powered analysis
2Java, C#, Ruby, PHP, Swift, Kotlin, C, C++Regex + heuristic analysis
3Any text fileLine-based checks (length, TODOs, secrets, duplication)

Development

git clone https://github.com/TedoNeObichaJavaScript/ReadyOrAI.git
cd ReadyOrAI
npm install
npm run build
npm test

Support

If you find ReadyOrAI useful, consider supporting the project:

  • Borko — 5 euro

License

MIT

الأسئلة الشائعة

ما هو io.github.TedoNeObichaJavaScript/readyorai؟

Zero-cost MCP server for local code inspection and best-practice recommendations

كيف أثبّت io.github.TedoNeObichaJavaScript/readyorai؟

يعمل على جهازك. في Claude Code: claude mcp add readyorai -- npx -y readyorai@0.1.2. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.TedoNeObichaJavaScript/readyorai إلى مفتاح API؟

لا يذكر إدراجه في السجل أي مفتاح أو سر إلزامي. قد تتطلب بعض الميزات حسابًا لدى الخدمة التي يتصل بها.

هل io.github.TedoNeObichaJavaScript/readyorai مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون io.github.TedoNeObichaJavaScript/readyorai؟

ينشره TedoNeObichaJavaScript. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.