An open API service indexing awesome lists of open source software.

https://github.com/vaur94/agent-docs-server

Loopback agent documentation server with MCP, Admin UI, and knowledge graph
https://github.com/vaur94/agent-docs-server

agents documentation knowledge-graph mcp opencode sqlite systemd typescript

Last synced: 21 days ago
JSON representation

Loopback agent documentation server with MCP, Admin UI, and knowledge graph

Awesome Lists containing this project

README

          

# agent-docs-server

[![CI](https://github.com/vaur94/agent-docs-server/actions/workflows/ci.yml/badge.svg)](https://github.com/vaur94/agent-docs-server/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Node](https://img.shields.io/badge/node-%3E%3D20-brightgreen)](package.json)

Local loopback documentation server for AI agents: SQLite knowledge store, MCP tools, knowledge-graph extraction, TR/EN Admin UI, and OpenCode/systemd install helpers.

`1.0.0-rc.1` is a local-alpha RC1 for one operator on `127.0.0.1`. Auth disabled by default is intentional for this loopback-only release candidate.

- [Contributing](CONTRIBUTING.md)
- [Security](SECURITY.md)
- [Changelog](CHANGELOG.md)
- [GitHub project guide](docs/github/README.md)
- [Release runbook](docs/release/release-runbook.md)

Use `docs-server init`, `docs-server add-project`, and `docs-server rescan` to prepare and refresh project documentation indexes. worker auto-start daemonization is not included; run `docs-server rescan` explicitly for scan work.

## Install

From a source checkout:

```bash
./scripts/install.sh
# or
pnpm setup
```

Full local setup (HTTP systemd service + OpenCode MCP + global `docs-server` on PATH):

```bash
./scripts/install.sh --all --global
```

Options: `--opencode`, `--service`, `--skip-deps`, `--skip-build`, `--opencode-dry-run`. Run `./scripts/install.sh --help` for the full list.

## Run as a systemd user service

Build the server, then install a user-level systemd unit that starts on login and restarts on failure:

```bash
pnpm install
pnpm build
node dist/bin/docs-server.js service install
```

Optional: point the unit at a different checkout with `--install-root /path/to/agent-docs-server`.

Runtime configuration lives in `~/.config/agent-docs/server.env` (created on first install). Edit `DOCS_SERVER_HOST`, `DOCS_SERVER_PORT`, or `DOCS_SERVER_DB_PATH` there, then run:

```bash
systemctl --user restart agent-docs-server.service
```

Service management:

```bash
node dist/bin/docs-server.js service status
systemctl --user status agent-docs-server.service
systemctl --user stop agent-docs-server.service
node dist/bin/docs-server.js service uninstall
```

After install, the Admin UI is at `http://127.0.0.1:3847/ui/` (default port).

## OpenCode MCP install

Register the `agentDocs` MCP server in `~/.config/opencode/opencode.jsonc` without touching other MCP entries. The command backs up the existing file, merges only `mcp.agentDocs` and `tools.agentDocs*`, and runs database migrations when the entry changes.

```bash
pnpm build
node dist/bin/docs-server.js opencode install
```

Preview changes first:

```bash
node dist/bin/docs-server.js opencode install --dry-run
```

Restart OpenCode after install so agents can call `agentDocs_*` tools.

## Foreground and MCP

```bash
docs-server start
docs-server mcp
```

Release validation is `pnpm install`, `pnpm check`, and `pnpm pack`.