mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-09-09 19:45:37 +03:00
75a4585c20
Simplify the documentation structure in `README.md` by removing the `todo/` directory reference and detailed design documents for planned features. Consolidate future roadmap items into a high-level summary under "Future Enhancements". Update `node-control-tools.md` to include documentation for new topology management tools (create node, create link, get template, rename node) and reflect updated API imports for `Link` support.
119 lines
3.6 KiB
Markdown
119 lines
3.6 KiB
Markdown
# GNS3 AI Copilot Documentation
|
|
|
|
This directory contains design documentation, implementation guides, and future plans for the GNS3 AI Copilot feature.
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
docs/gns3-copilot/
|
|
├── README.md # This file
|
|
└── implemented/ # Implemented features and designs
|
|
├── chat-api.md # Chat API design (SSE, session management)
|
|
├── llm-model-configs.md # LLM model configuration system
|
|
├── command-security.md # Command security and filtering
|
|
├── context-window-management.md # Context window optimization
|
|
└── node-control-tools.md # Node start/stop/suspend tools for lab automation
|
|
```
|
|
|
|
## Implemented Features
|
|
|
|
### Chat API (`implemented/chat-api.md`)
|
|
The core Chat API that enables AI-powered conversations within GNS3 projects.
|
|
|
|
**Key Features:**
|
|
- Server-Sent Events (SSE) for streaming responses
|
|
- Project-level session isolation
|
|
- Session management (CRUD operations)
|
|
- Statistics tracking (messages, tokens, LLM calls)
|
|
- User-level LLM configuration
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### LLM Model Configs (`implemented/llm-model-configs.md`)
|
|
Multi-level LLM model configuration system.
|
|
|
|
**Key Features:**
|
|
- System-wide defaults
|
|
- Group-level configurations
|
|
- User-level overrides
|
|
- Runtime parameter adjustment
|
|
- Model provider abstraction
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Command Security (`implemented/command-security.md`)
|
|
Security framework for AI-generated commands.
|
|
|
|
**Key Features:**
|
|
- Command filtering and validation
|
|
- Dangerous operation detection
|
|
- HITL (Human-in-the-Loop) confirmations
|
|
- Audit logging
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Context Window Management (`implemented/context-window-management.md`)
|
|
Optimization strategies for handling large project contexts.
|
|
|
|
**Key Features:**
|
|
- Intelligent content filtering
|
|
- Token usage optimization
|
|
- Summary generation
|
|
- Context compression
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
### Node Control Tools (`implemented/node-control-tools.md`)
|
|
Tools for controlling network device lifecycle in GNS3 projects.
|
|
|
|
**Key Features:**
|
|
- Start nodes with progress tracking
|
|
- Quick start for automated workflows
|
|
- Stop nodes for lab shutdown
|
|
- Batch operations support
|
|
- Mode-based access control
|
|
|
|
**Status:** ✅ Implemented
|
|
|
|
## Future Enhancements
|
|
|
|
The following features are currently under consideration or development:
|
|
|
|
- Configuration Templates: Template-based configuration generation for multi-vendor network devices
|
|
- Vision-based Topology Creation: Create network topologies from images/diagrams
|
|
- Enhanced HITL Workflows: Advanced Human-in-the-Loop confirmation patterns
|
|
- Web UI Enhancements: Improved management interfaces
|
|
|
|
## Contributing
|
|
|
|
When adding new documentation:
|
|
|
|
1. **Implementation:** Add documentation to `implemented/` when feature is complete
|
|
2. **Naming:** Use concise names like `{feature}.md`
|
|
|
|
## Document Status Legend
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| ✅ Implemented | Feature is fully implemented and deployed |
|
|
| 📋 Design Complete | Design is done, awaiting implementation |
|
|
| 🚧 In Progress | Currently being implemented |
|
|
| 💡 Proposed | Initial idea or proposal |
|
|
|
|
## Related Documentation
|
|
|
|
- [GNS3 Server API Documentation](https://api.gns3.com/)
|
|
- [GNS3 Web UI Documentation](https://docs.gns3.com/)
|
|
- [LangGraph Documentation](https://langchain-ai.github.io/langgraph/)
|
|
- [FastAPI Documentation](https://fastapi.tiangolo.com/)
|
|
|
|
## Quick Links
|
|
|
|
- **Current Feature Branch:** `feature/ai-copilot-bridge`
|
|
- **Main Branch:** `master`
|
|
- **Issue Tracker:** [GitHub Issues](https://github.com/GNS3/gns3-server/issues)
|
|
|
|
---
|
|
|
|
_Last updated: 2026-03-12_
|