Move scripts to docgen/, remove possess_flow.png

- docgen/: generate.py, ue_parser.py, ue_markdown.py, ue_mcp_server.py
- .mcp.json: update server path to docgen/ue_mcp_server.py
- Update CLAUDE.md and README paths accordingly

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-02-27 08:26:47 -05:00
parent 5c1b5bf3b8
commit 217f1f99dd
8 changed files with 19 additions and 19 deletions

View File

@@ -2,7 +2,7 @@
"mcpServers": { "mcpServers": {
"ue-docs": { "ue-docs": {
"command": "python", "command": "python",
"args": ["ue_mcp_server.py"] "args": ["docgen/ue_mcp_server.py"]
} }
} }
} }

View File

@@ -8,20 +8,20 @@ UnrealDocGenerator is a tool for generating documentation from Unreal Engine C++
## Current State ## Current State
Implementation complete. Four Python files + MCP registration: Implementation complete. Scripts live in `docgen/`:
- `ue_parser.py` — Parses UE headers into dataclasses - `docgen/ue_parser.py` — Parses UE headers into dataclasses
- `ue_markdown.py` — Renders parsed data as Markdown (ultra-compact format, documented items only) - `docgen/ue_markdown.py` — Renders parsed data as Markdown (ultra-compact format, documented items only)
- `generate.py` — CLI entry point; two-pass pipeline (parse-all → build type index → render-all) - `docgen/generate.py` — CLI entry point; two-pass pipeline (parse-all → build type index → render-all)
- `ue_mcp_server.py` — MCP server exposing 5 tools for item-granularity doc lookups - `docgen/ue_mcp_server.py` — MCP server exposing 5 tools for item-granularity doc lookups
- `.mcp.json` — Registers the MCP server with Claude Code (stdio transport) - `.mcp.json` — Registers the MCP server with Claude Code (stdio transport)
## Usage ## Usage
```bash ```bash
python generate.py <input> [input2 ...] <output_dir> python docgen/generate.py <input> [input2 ...] <output_dir>
python generate.py Runtime/Engine/ Runtime/AIModule/ docs/ # multiple directories python docgen/generate.py Runtime/Engine/ Runtime/AIModule/ docs/ # multiple directories
python generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/ # single file python docgen/generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/ # single file
``` ```
Output: one `.md` per `.h` + `docs/type-index.txt` (compact `TypeName: path/to/File.md` lookup). Output: one `.md` per `.h` + `docs/type-index.txt` (compact `TypeName: path/to/File.md` lookup).
@@ -30,7 +30,7 @@ The last argument is always the output directory. All preceding arguments are in
## MCP Server ## MCP Server
`ue_mcp_server.py` exposes 5 tools Claude can call directly: `docgen/ue_mcp_server.py` exposes 5 tools Claude can call directly:
| Tool | Purpose | | Tool | Purpose |
|---|---| |---|---|

View File

@@ -4,27 +4,27 @@ Generates compact, agent-readable Markdown documentation from Unreal Engine C++
## How it works ## How it works
1. **Parse**`ue_parser.py` scans UE headers into dataclasses using a position-based scanner (handles nested braces, macros, delegates, namespaces). 1. **Parse**`docgen/ue_parser.py` scans UE headers into dataclasses using a position-based scanner (handles nested braces, macros, delegates, namespaces).
2. **Render**`ue_markdown.py` emits one `.md` per header: only items with C++ doc comments, no deprecated functions, compact enum format. 2. **Render**`docgen/ue_markdown.py` emits one `.md` per header: only items with C++ doc comments, no deprecated functions, compact enum format.
3. **Index**`generate.py` produces `type-index.txt`: a flat `TypeName: path/to/File.md` lookup for instant type resolution. 3. **Index**`docgen/generate.py` produces `type-index.txt`: a flat `TypeName: path/to/File.md` lookup for instant type resolution.
4. **Serve**`ue_mcp_server.py` exposes the docs to Claude as callable MCP tools. 4. **Serve**`docgen/ue_mcp_server.py` exposes the docs to Claude as callable MCP tools.
## Usage ## Usage
```bash ```bash
python generate.py <input> [input2 ...] <output_dir> python docgen/generate.py <input> [input2 ...] <output_dir>
# Examples # Examples
python generate.py /path/to/UnrealEngine/Engine/Source/ docs/ python docgen/generate.py /path/to/UnrealEngine/Engine/Source/ docs/
python generate.py Runtime/Engine/ Runtime/AIModule/ Runtime/GameplayTags/ docs/ python docgen/generate.py Runtime/Engine/ Runtime/AIModule/ Runtime/GameplayTags/ docs/
python generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/ python docgen/generate.py Runtime/Engine/Classes/GameFramework/Actor.h docs/
``` ```
The last argument is always the output directory. All preceding arguments are inputs (files or directories, processed recursively). Output: one `.md` per `.h` + `docs/type-index.txt`. The last argument is always the output directory. All preceding arguments are inputs (files or directories, processed recursively). Output: one `.md` per `.h` + `docs/type-index.txt`.
## MCP Server ## MCP Server
`ue_mcp_server.py` is a Claude Code MCP server that gives Claude item-granularity access to the generated docs — fetching one class overview or one function instead of an entire file. `docgen/ue_mcp_server.py` is a Claude Code MCP server that gives Claude item-granularity access to the generated docs — fetching one class overview or one function instead of an entire file.
### Setup ### Setup

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB