docs: fix stale README facts (license, counts, clone URL, structure)
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:
@@ -1,20 +1,23 @@
|
|||||||
# KNEL-AIMiddleware
|
# KNEL-AIMiddleware
|
||||||
|
|
||||||
[](https://www.docker.com/)
|
[](https://www.docker.com/)
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[](https://modelcontextprotocol.io/)
|
[](https://modelcontextprotocol.io/)
|
||||||
[](https://microsoft.github.io/language-server-protocol/)
|
[](https://microsoft.github.io/language-server-protocol/)
|
||||||
[](PRODUCTION-READY.md)
|
[](PRODUCTION-READY.md)
|
||||||
|
|
||||||
> MCP and LSP infrastructure for OpenWebUI and Crush to utilize
|
> 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
|
## Production Status
|
||||||
|
|
||||||
| Category | Production Ready | Total | Status |
|
| Category | Production Ready | Total | Status |
|
||||||
|----------|-----------------|-------|--------|
|
|----------|-----------------|-------|--------|
|
||||||
| MCP Servers | 27 | 38 | 71% |
|
| MCP Servers | 29 | 38 | 76% |
|
||||||
| LSP Servers | 4 | 4 | 100% |
|
| 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.**
|
**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**
|
1. **Clone the repository**
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/KNEL/KNEL-AIMiddleware.git
|
git clone https://git.knownelement.com/ukrrs/KNEL-AIMiddleware.git
|
||||||
cd KNEL-AIMiddleware
|
cd KNEL-AIMiddleware
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -215,6 +218,12 @@ Check build status of all services:
|
|||||||
./scripts/StatusCheck.sh
|
./scripts/StatusCheck.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### scripts/validate-mcp.sh / validate-all.sh
|
||||||
|
Validate MCP server configurations (all or one):
|
||||||
|
```bash
|
||||||
|
./scripts/validate-all.sh
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Docker Compose Commands
|
### Docker Compose Commands
|
||||||
@@ -362,11 +371,18 @@ KNEL-AIMiddleware/
|
|||||||
│ ├── bash-language-server/
|
│ ├── bash-language-server/
|
||||||
│ ├── docker-language-server/
|
│ ├── docker-language-server/
|
||||||
│ └── marksman/
|
│ └── 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)
|
├── vendor/ # Cloned repositories (gitignored)
|
||||||
├── docs/ # Documentation
|
├── docs/ # Documentation
|
||||||
│ └── SDLC.md # Software Development Lifecycle
|
│ └── SDLC.md # Software Development Lifecycle
|
||||||
├── AGENTS.md # AI agent guidelines and rules
|
├── AGENTS.md # AI agent guidelines and rules
|
||||||
├── STATUS.md # Server status and progress tracking
|
├── 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)
|
├── JOURNAL.md # Development journal (ADRs, insights)
|
||||||
└── README.md # This file
|
└── README.md # This file
|
||||||
```
|
```
|
||||||
@@ -442,7 +458,7 @@ Contributions are welcome! Please see [AGENTS.md](AGENTS.md) for development gui
|
|||||||
|
|
||||||
## License
|
## 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.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user