# Customer Guide

Vivado Context MCP helps AI tools understand a local Vivado or FPGA project without scanning the entire project folder.

## What It Does

- Finds the Vivado project and active project files.
- Filters generated Vivado folders such as runs, cache, simulation output, and IP products.
- Summarizes top modules, simulation entry points, constraints, IP, and block designs.
- Reports estimated token savings compared with a raw project scan.
- Runs locally by default and does not upload source code.
- Stores reusable context output under `.vivado_ai_mcp/context/`.

## Typical Use

```bash
vivado-context summarize path/to/project.xpr --detail normal
vivado-context entry-points path/to/project.xpr
vivado-context clock-reset path/to/project.xpr
vivado-context bd-summary path/to/project.xpr
vivado-context report path/to/project.xpr --write
```

On Windows, the project also includes wrapper scripts:

```bat
scripts\vivado_context.cmd summarize path\to\project.xpr
scripts\demo_report.cmd path\to\project.xpr
```

## What To Expect

The output is a compact project map. It is intended to guide an AI agent toward the right files and questions before the agent reads source code or asks Vivado for detailed reports.

Generated context evidence is written under:

```text
.vivado_ai_mcp/
  context/
```

This directory is local to the customer project. Add `.vivado_ai_mcp/` to
`.gitignore` unless the team intentionally wants to keep small summary files.

## Demo Reference

See [RFDC MicroBlaze Demo](rf_ip_mb_one_pager.md) for a one-page customer-facing example based on a real Vivado project.

## Limitations

This tool is not a full HDL compiler and does not replace Vivado. Use Vivado or `vivado_mcp_pro` for authoritative synthesis, implementation, timing, utilization, and hardware results.
