From fca9298d20aec27d782fb336025f9c7761a9a6bb Mon Sep 17 00:00:00 2001 From: Dominik Jain Date: Fri, 26 Sep 2025 21:36:15 +0200 Subject: [PATCH] Add README --- prepare-api-docs/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 prepare-api-docs/README.md diff --git a/prepare-api-docs/README.md b/prepare-api-docs/README.md new file mode 100644 index 0000000..31b14da --- /dev/null +++ b/prepare-api-docs/README.md @@ -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`. \ No newline at end of file