README.mdâĸ2.4 kB
# Documentation
This directory contains all documentation for the `mcp-abap-adt` project, organized by audience.
## đ Structure
### [installation/](installation/) - For Administrators
Complete installation instructions for different platforms and environments.
- `INSTALLATION.md` - Main installation guide with quick links
- `platforms/` - Platform-specific installation guides
- `INSTALL_WINDOWS.md` - Windows installation
- `INSTALL_MACOS.md` - macOS installation
- `INSTALL_LINUX.md` - Linux installation
### [user-guide/](user-guide/) - For Users
Documentation for end users: configuration, usage, and available tools.
- `CLIENT_CONFIGURATION.md` - How to configure MCP clients to connect to the server
- `AVAILABLE_TOOLS.md` - Complete list of available MCP tools and their descriptions
### [architecture/](architecture/) - For Developers
Technical documentation about the system architecture, design decisions, and internal structure.
- `STATEFUL_SESSION_GUIDE.md` - Stateful session management in SAP ADT API
- `TOOLS_ARCHITECTURE.md` - MCP tools architecture and handler structure
- `README.md` - Architecture documentation index
### [development/](development/) - For Developers
Documentation for developers: testing, development guides, and internal documentation.
- `ASSISTANT_GUIDELINES.md` - Guidelines for AI assistants working on this project
- `TEST_SYSTEM_SETUP.md` - Test system setup guide
- `DetectObjectTypeListTools.md` - Documentation for object type detection tools
- `tests/` - Test documentation and configuration
- `TESTING_GUIDE.md` - Testing guide
- `TEST_INFRASTRUCTURE.md` - Test infrastructure documentation
- `ORGANIZATION.md` - Test organization
- `test-config.yaml.template` - Test configuration template
## đ Quick Links
- **Getting Started**: [Installation Guide](installation/INSTALLATION.md)
- **User Configuration**: [Client Configuration](user-guide/CLIENT_CONFIGURATION.md)
- **Available Tools**: [Tools List](user-guide/AVAILABLE_TOOLS.md)
- **Architecture**: [Stateful Sessions](architecture/STATEFUL_SESSION_GUIDE.md)
- **Development**: [Development Documentation](development/)
## đ Package-Specific Documentation
Package-specific documentation is available in the respective npm packages:
- `@mcp-abap-adt/adt-clients` - ADT clients package documentation
- `@mcp-abap-adt/connection` - Connection package documentation