Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/MCP_STDIO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# MCP stdio integration

The MCP server lives in mcp/.

Use it when ChatGPT or a Gateway should call html-explainer as a tool instead of relying only on remembered instructions.

## First version

The first version is intentionally conservative:

- stdio transport
- official MCP TypeScript SDK
- read/list/audit/validate tools only
- repo-root path safety
- smoke test
- no artifact generation yet

## Why this is minimal

The repo is now strong enough conceptually. The MCP risk is operational: bad schemas, unstable stdio, unsafe paths, or too much generation logic in the server.

This version avoids those risks and proves the connection layer first.

## Next step

After stdio and Gateway are stable, add generation tools in a separate PR.
1 change: 1 addition & 0 deletions mcp/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
34 changes: 34 additions & 0 deletions mcp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# html-explainer MCP

Minimal stdio MCP server for html-explainer.

## Scope

This first version proves the connection layer. It exposes read, audit, and validation tools.

It does not generate or write artifacts yet.

## Tools

- html_explainer_status
- html_explainer_list_patterns
- html_explainer_get_golden_cases
- html_explainer_read_product_doc
- html_explainer_audit_file
- html_explainer_validate_repo

## Run

From the mcp folder:

npm install
npm test
npm start

## Gateway command

node /absolute/path/to/html-explainer/mcp/src/server.js

## Rollback

Delete the mcp folder.
Loading
Loading