UKRRS/KNEL-AIMiddleware
7
0
Fork 0
Code Pull Requests Actions Packages Releases Activity

docs: fix stale README facts (license, counts, clone URL, structure)

Browse Source 
License is AGPLv3, not MIT (badge + footer). Production counts now
match PRODUCTION-READY.md (33/42, MCP 29/38). Clone URL points at the
ukrrs Gitea remote. Project structure lists tooling-cli/, wrapper
scripts, run.sh/maintenance.sh; validate scripts documented; Status
front-matter line added per the org docs standard.

💘 Generated with Crush

Assisted-by: Crush:glm-5.2
This commit is contained in:
mrcharles
2026-08-28 21:13:41 -05:00
parent 2440188f1f
commit 6476304b35
1 changed files with 22 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -6
View File
@@ -1,20 +1,23 @@
# KNEL-AIMiddleware
[![Docker](https://img.shields.io/badge/Docker-Ready-blue.svg)](https://www.docker.com/)
[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![License](https://img.shields.io/badge/License-AGPLv3-green.svg)](LICENSE)
[![MCP](https://img.shields.io/badge/MCP-Compatible-orange.svg)](https://modelcontextprotocol.io/)
[![LSP](https://img.shields.io/badge/LSP-Compatible-purple.svg)](https://microsoft.github.io/language-server-protocol/)
[![Production](https://img.shields.io/badge/Production-31%2F42%20Ready-brightgreen.svg)](PRODUCTION-READY.md)
[![Production](https://img.shields.io/badge/Production-33%2F42%20Ready-brightgreen.svg)](PRODUCTION-READY.md)
> MCP and LSP infrastructure for OpenWebUI and Crush to utilize
Status: 2026-08-28 — production (33 of 42 servers ready); tooling-cli CLIs
under active development.
## Production Status
| Category | Production Ready | Total | Status |
|----------|-----------------|-------|--------|
| MCP Servers | 27 | 38 | 71% |
| MCP Servers | 29 | 38 | 76% |
| LSP Servers | 4 | 4 | 100% |
| **Total** | **31** | **42** | **74%** |
| **Total** | **33** | **42** | **79%** |
**See [PRODUCTION-READY.md](PRODUCTION-READY.md) for the complete list of deployable servers.**
@@ -168,7 +171,7 @@ Most use `uvx` for installation:
1. **Clone the repository**
```bash
git clone https://github.com/KNEL/KNEL-AIMiddleware.git
git clone https://git.knownelement.com/ukrrs/KNEL-AIMiddleware.git
cd KNEL-AIMiddleware
```
@@ -215,6 +218,12 @@ Check build status of all services:
./scripts/StatusCheck.sh
```
#### scripts/validate-mcp.sh / validate-all.sh
Validate MCP server configurations (all or one):
```bash
./scripts/validate-all.sh
```
## Usage
### Docker Compose Commands
@@ -362,11 +371,18 @@ KNEL-AIMiddleware/
│ ├── bash-language-server/
│ ├── docker-language-server/
│ └── marksman/
├── mcp-*-wrapper.sh # Per-service MCP wrapper scripts (crush integration)
├── lsp-*-wrapper.sh # Per-service LSP wrapper scripts
├── run.sh # Push container images to the Gitea Docker registry
├── maintenance.sh # Combined maintenance operations (old Makefile)
├── tooling-cli/ # Go CLIs (redmine, discourse, dns, KNELCredsManager)
├── vendor/ # Cloned repositories (gitignored)
├── docs/ # Documentation
│ └── SDLC.md # Software Development Lifecycle
├── AGENTS.md # AI agent guidelines and rules
├── STATUS.md # Server status and progress tracking
├── PRODUCTION-READY.md # Deployable server list
├── LSP_SETUP.md # LSP setup notes
├── JOURNAL.md # Development journal (ADRs, insights)
└── README.md # This file
```
@@ -442,7 +458,7 @@ Contributions are welcome! Please see [AGENTS.md](AGENTS.md) for development gui
## License
This project is licensed under the MIT License - see [LICENSE](LICENSE) file for details.
This project is licensed under the GNU AGPLv3 - see [LICENSE](LICENSE) file for details.
---