|
| 1 | +# Project Structure |
| 2 | + |
| 3 | +This document outlines the directory and file structure of the `llm-wrapper-mcp-server` project. |
| 4 | + |
| 5 | +``` |
| 6 | +. |
| 7 | +├── .gitignore |
| 8 | +├── CHANGELOG.md |
| 9 | +├── LICENSE |
| 10 | +├── pyproject.toml |
| 11 | +├── README.md |
| 12 | +├── requirements.txt |
| 13 | +├── config/ |
| 14 | +│ └── prompts/ |
| 15 | +│ └── system.txt |
| 16 | +├── data/ |
| 17 | +├── docs/ |
| 18 | +│ └── STRUCTURE.md |
| 19 | +├── logs/ |
| 20 | +├── src/ |
| 21 | +│ └── llm_wrapper_mcp_server/ |
| 22 | +│ ├── __init__.py |
| 23 | +│ ├── __main__.py |
| 24 | +│ ├── llm_client.py |
| 25 | +│ ├── llm_mcp_server.py |
| 26 | +│ ├── llm_mcp_wrapper.py |
| 27 | +│ └── logger.py |
| 28 | +├── tests/ |
| 29 | +│ ├── test_llm_client.py |
| 30 | +│ ├── test_llm_mcp_wrapper.py |
| 31 | +│ ├── test_model_validation.py |
| 32 | +│ └── test_openrouter.py |
| 33 | +└── version_manager.py |
| 34 | +└── release_orchestrator.py |
| 35 | +└── build.bat |
| 36 | +``` |
| 37 | + |
| 38 | +### Directory Descriptions: |
| 39 | + |
| 40 | +* `.`: The root directory of the project. |
| 41 | +* `config/`: Contains configuration files for the application. |
| 42 | + * `prompts/`: Stores system prompts used by the LLM. |
| 43 | +* `data/`: Intended for storing any data files generated or used by the application. |
| 44 | +* `docs/`: Contains project documentation, including this structure description. |
| 45 | +* `logs/`: Stores application log files. |
| 46 | +* `src/`: Contains the source code of the application. |
| 47 | + * `llm_wrapper_mcp_server/`: The main Python package for the LLM wrapper MCP server. |
| 48 | +* `tests/`: Contains unit and integration tests for the project. |
| 49 | + |
| 50 | +### File Descriptions: |
| 51 | + |
| 52 | +* `.gitignore`: Specifies intentionally untracked files to ignore by Git. |
| 53 | +* `CHANGELOG.md`: Documents all notable changes to the project. |
| 54 | +* `LICENSE`: Contains the licensing information for the project. |
| 55 | +* `pyproject.toml`: Project configuration file, including build system and dependencies. |
| 56 | +* `README.md`: Provides a general overview of the project, setup instructions, and usage. |
| 57 | +* `requirements.txt`: Lists the Python dependencies required for the project. |
| 58 | +* `src/llm_wrapper_mcp_server/__init__.py`: Initializes the `llm_wrapper_mcp_server` Python package. |
| 59 | +* `src/llm_wrapper_mcp_server/__main__.py`: Entry point for running the package as a script. |
| 60 | +* `src/llm_wrapper_mcp_server/llm_client.py`: Handles interactions with LLM APIs. |
| 61 | +* `src/llm_wrapper_mcp_server/llm_mcp_server.py`: Implements the MCP server logic for the LLM wrapper. |
| 62 | +* `src/llm_wrapper_mcp_server/llm_mcp_wrapper.py`: Wraps LLM functionalities for MCP integration. |
| 63 | +* `src/llm_wrapper_mcp_server/logger.py`: Configures and provides logging utilities. |
| 64 | +* `tests/test_llm_client.py`: Tests for the `llm_client.py` module. |
| 65 | +* `tests/test_llm_mcp_wrapper.py`: Tests for the `llm_mcp_wrapper.py` module. |
| 66 | +* `tests/test_model_validation.py`: Tests for model validation logic. |
| 67 | +* `tests/test_openrouter.py`: Tests specific to the OpenRouter LLM integration. |
0 commit comments