mirror of
https://github.com/penpot/penpot-mcp.git
synced 2026-04-25 11:18:37 +00:00
Add README
This commit is contained in:
parent
74ff6a12df
commit
fca9298d20
21
prepare-api-docs/README.md
Normal file
21
prepare-api-docs/README.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# Preparation of API Documentation for the MCP Server
|
||||||
|
|
||||||
|
The script `prepare_api_docs.py` read API documentation from the Web
|
||||||
|
and collects it in a single yaml file, which is then used by an MCP
|
||||||
|
tool to provide API documentation to an LLM on demand.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Pixi is used for environment management.
|
||||||
|
|
||||||
|
Install the environment via:
|
||||||
|
|
||||||
|
pixi install
|
||||||
|
|
||||||
|
## Running the Script
|
||||||
|
|
||||||
|
To run the script, use:
|
||||||
|
|
||||||
|
pixi run python prepare_api_docs.py
|
||||||
|
|
||||||
|
This will generate `../mcp-server/data/api_types.yml`.
|
||||||
Loading…
x
Reference in New Issue
Block a user