Add README

This commit is contained in:
Dominik Jain 2025-09-26 21:36:15 +02:00 committed by Dominik Jain
parent 74ff6a12df
commit fca9298d20

View 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`.