Documentation

PromptFlow Engine docs

PromptFlow Engine is one deterministic TypeScript engine (@promptflow/engine) that parses, analyzes, optimizes, verifies, and scores prompts. The workspace, HTTP API, CLI, MCP server, and VS Code extension are all interfaces to that same engine, so a prompt gets the same result everywhere.

• Getting startedAnalyze and optimize your first prompt in the workspace, CLI, or API.
• How the engine worksThe pipeline, the rule catalogue, the scoring formula, and candidate verification.
• HTTP APIStateless JSON endpoints, limits, errors, and examples.
• CLI & CI gateEvery command, plus the check gate for prompt files in CI.
• MCP serverTools, resources, and client configuration for agents and IDEs.
• VS Code extensionSidebar optimizer, commands, codebase-to-prompt, and the privacy guard.
• Privacy & securityWhat runs where, what is stored, and what is logged.

What it does not do

• It does not call a language model. Every result comes from documented rules, so it is free, instant, private, and reproducible.
• It does not invent missing content. Gaps such as an unspecified output format become suggestions for you.
• It does not run your prompt against a model. Model-based testing is on the roadmap.