English Français العربية

io.github.samouh-waleed/prompyai

السجل الرسمي الذكاء الاصطناعي والوكلاء

Scores your prompts against your real codebase — context-aware prompt intelligence

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

ماذا يمكنك أن تفعل مع io.github.samouh-waleed/prompyai؟

  • Score (0–100) across 4 dimensions
  • Suggestions tailored to your project
  • AI-enhanced prompt rewritten with real file paths, verified symbols, and codebase context

التثبيت

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

NPM package prompyai-mcp
Claude Code 
claude mcp add prompyai -e 'ANTHROPIC_API_KEY=<your anthropic_api_key>' -- npx -y prompyai-mcp@0.1.1
إعداد JSON (Claude Desktop وCursor وVS Code) 
{
    "mcpServers": {
        "prompyai": {
            "command": "npx",
            "args": [
                "-y",
                "prompyai-mcp@0.1.1"
            ],
            "env": {
                "ANTHROPIC_API_KEY": "<your anthropic_api_key>"
            }
        }
    }
}

متغيرات البيئة

  • ANTHROPIC_API_KEY سري Anthropic API key for AI-powered suggestions (optional — free heuristic scoring works without it)

التوثيق

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

المحتويات
  1. PrompyAI
  2. What It Does
  3. Quick Start
  4. How AI Enhancement Works
  5. Scoring Dimensions
  6. Features
  7. MCP Tools
  8. Environment Variables
  9. Architecture
  10. Development
  11. Links
  12. License

PrompyAI

Context-aware prompt intelligence for Claude CLI.

Scores your prompts against your real codebase — file paths, symbols, session history — and rewrites them with AI.

What It Does

When you write a prompt in Claude CLI, PrompyAI automatically evaluates it against your actual project and returns:

  • Score (0–100) across 4 dimensions
  • Suggestions tailored to your project
  • AI-enhanced prompt rewritten with real file paths, verified symbols, and codebase context
Prompt Score: 43/100 [D]

  Specificity         3/25  ==..............
  Context Completeness 13/25  ========........
  Task Clarity        15/25  =========.......
  File & Folder Anchoring 10/25  ======..........

Key improvements:
  1. Expand your prompt with more context
  2. Add file paths using @mentions
  3. Specify what format you expect the output in
  4. Add acceptance criteria

Try something more like:

  "Build the VS Code extension in packages/vscode-extension/ that integrates
   with the PrompyAI MCP server at packages/mcp-server/. It should provide
   real-time prompt scoring in the editor sidebar, show score breakdowns
   (specificity, context, clarity, anchoring), and offer a 'rewrite prompt'
   action. Use the shared types from packages/shared/."

Quick Start

claude mcp add prompyai -- npx prompyai-mcp serve

That's it. No sign-up, no config files. Works immediately.

Requires Node.js 20+ and Claude CLI.

How AI Enhancement Works

PrompyAI uses a two-layer architecture so all users get AI-enhanced output:

User typeHow it works
API key users (ANTHROPIC_API_KEY set)PrompyAI calls Claude Haiku directly for fast, dedicated AI rewrites
Subscription users (no API key)PrompyAI returns codebase context to Claude, and Claude itself generates the enhanced prompt using your existing session

Either way, the enhanced prompt is grounded in your real project — actual file paths, verified function names, and project architecture.

Scoring Dimensions

Each dimension scores 0–25, total 0–100.

DimensionWhat it measures
SpecificityConcrete actions vs vague verbs, output format, quantitative constraints
Context CompletenessFile references, error messages, expected vs actual behavior
Task ClaritySingle focused task, success criteria, unambiguous language
File & Folder Anchoring@mentions, project entity references, verified symbol names

Grades: A (90+) · B (70+) · C (50+) · D (30+) · F (<30)

Features

  • Auto-scoring — Evaluates every prompt automatically, no manual trigger needed
  • AI-enhanced for everyone — API key users get Haiku rewrites; subscription users get Claude-powered rewrites via codebase context
  • Context-aware — Indexes your file tree, tech stack, git state, and code symbols via the TypeScript Compiler API
  • Session-aware — Reads Claude Code conversation history for multi-turn context
  • Symbol verification — Confirms that function/class names you reference actually exist in your code
  • Monorepo support — Detects tech stacks across workspace packages
  • Toggle — Say "pause prompyai" or "enable prompyai" at any time

MCP Tools

evaluate_prompt

Automatically called on every user message. Scores your prompt against your project.

ParameterRequiredDescription
promptyesThe prompt text to evaluate
workspace_pathyesAbsolute path to your project
active_filenoCurrently open file path
session_idnoClaude Code session ID for multi-turn context
get_context

Returns your project summary: tech stack, recent files, key folders, AI instruction files.

ParameterRequiredDescription
workspace_pathyesAbsolute path to your project
prompyai_toggle

Turns auto-evaluation on or off.

ParameterRequiredDescription
enabledyestrue to enable, false to disable

Environment Variables

VariableRequiredDescription
ANTHROPIC_API_KEYNoEnables direct AI suggestions via Claude Haiku (optional — works without it)
PROMPYAI_TELEMETRYNoSet to false to opt out of anonymous telemetry

Architecture

PrompyAI/
├── packages/
│   ├── mcp-server/     ← Core product (npm: prompyai-mcp)
│   ├── landing/        ← Website (prompyai.com)
│   └── shared/         ← Shared types for future IDE extensions
├── CLAUDE.md
└── README.md
Scoring Pipeline
User prompt
  → WorkspaceIndexer (file tree, stack, symbols)
  → ContextResolver (map prompt to codebase)
  → HeuristicScorer (20+ rules, 4 dimensions)
  → AISuggestionGenerator (Haiku or Claude-as-AI-layer)
  → DisplayFormatter (pre-formatted output)

Development

pnpm install          # Install dependencies
pnpm test             # Run tests (220 tests)
pnpm typecheck        # Type check
pnpm build            # Build

License

MIT

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

ما هو io.github.samouh-waleed/prompyai؟

Scores your prompts against your real codebase — context-aware prompt intelligence

كيف أثبّت io.github.samouh-waleed/prompyai؟

يعمل على جهازك. في Claude Code: claude mcp add prompyai -e 'ANTHROPIC_API_KEY=<your anthropic_api_key>' -- npx -y prompyai-mcp@0.1.1. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج io.github.samouh-waleed/prompyai إلى مفتاح API؟

نعم. يتطلب ANTHROPIC_API_KEY، وتضبطها في إعداداته.

هل io.github.samouh-waleed/prompyai مفتوح المصدر؟

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

من يصون io.github.samouh-waleed/prompyai؟

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

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