Documentary Server
FreeNot checkedEnables creating, listing, and searching project-based documentation with Markdown content, table of contents, full-text search, and multi-client support via St
About
Enables creating, listing, and searching project-based documentation with Markdown content, table of contents, full-text search, and multi-client support via Streamable HTTP transport.
README
NestJS + PostgreSQL + @rekog/mcp-nest ile proje bazli dokumantasyon olusturan ve listeleyen MCP sunucusu.
Ozellikler
- Proje bazli dokumanlar: Her dokuman bir
projectNameile gruplanir; backend/frontend gibi farkli agentlar kendi projelerinde calisir. - Dokuman olusturma: Markdown icerik, otomatik icindekiler (table of contents) ve slug.
- Arama: Full-text search (dogal dil) ve regex ile icerik arama.
- Minimal token kullanimi:
get_documenttool'undasectionIdile tek bir bolum okunabilir. - Multi-client destek: Streamable HTTP transport ile birden fazla agent ayni anda baglanabilir.
Gereksinimler
- Node.js 18+
- PostgreSQL 14+
Kurulum
yarn install
cp .env.example .env
# .env icinde DB_* degerlerini duzenleyin
yarn start:dev
- Uygulama:
http://localhost:3000 - MCP endpoint:
http://localhost:3000/mcp
MCP Araclari (Tools)
| Tool | Aciklama |
|---|---|
list_projects |
Tum projeleri listeler (proje adi + dokuman sayisi). Ilk adim olarak kullanin. |
create_document |
Belirtilen projede dokuman olusturur. Icerik Markdown; #, ## ile basliklar TOC'e eklenir. |
list_documents |
Bir projedeki dokumanlari listeler (id, title, slug, TOC, tarihler). |
search_documents |
Proje icinde full-text veya regex arama. Snippet doner. |
get_document |
Proje+slug veya id ile tam dokuman icerigi + TOC. sectionId ile tek bolum okunabilir. |
get_document_toc |
Sadece icindekiler; bolum bazli okumak icin get_document ile sectionId kullanilir. |
MCP Resource Template
- URI:
mcp://documents/{projectName}/{slug} - Tam dokuman: TOC + tum icerik.
Ornek: Backend agent dokumani yazar -> Frontend agent list_projects -> list_documents -> get_document_toc -> get_document ile sectionId vererek sadece ilgili bolumu okur.
Ornek kullanim (agent senaryolari)
- Backend agent:
create_documentileprojectName: "backend-api", baslik ve detayli Markdown icerik gonderir. - Frontend agent:
list_projects->search_documents(projectName: "backend-api", query: "login") ->get_document_toc->get_documentilesectionId: "login"vererek sadece ilgili bolumu okur.
Ortam degiskenleri
| Degisken | Varsayilan | Aciklama |
|---|---|---|
PORT |
3000 | HTTP portu |
DB_HOST |
localhost | PostgreSQL host |
DB_PORT |
5432 | PostgreSQL port |
DB_USER |
postgres | Kullanici |
DB_PASSWORD |
postgres | Sifre |
DB_NAME |
documentary_mcp | Veritabani adi |
DB_LOGGING |
false | SQL loglama |
MCP_API_KEY |
(bos) | Tanimliysa MCP endpoint'i API_KEY veya Authorization: Bearer header ile korunur |
Docker ile calistirma
Sunucuyu bilgisayarinizda surekli calisir halde tutmak icin Docker Compose kullanin:
cp .env.example .env
# Istege bagli: MCP_API_KEY=your-secret-key
docker compose up -d --build
- Uygulama:
http://localhost:3000 - MCP:
http://localhost:3000/mcp - Veritabani verisi
postgres_datavolume'da kalir.
Durdurmak: docker compose down
Cursor MCP ayari
Remote Server (HTTP - onerilen)
Sunucu Docker veya yarn start:dev ile calisiyorken Cursor'da Remote Server olarak ekleyin. ~/.cursor/mcp.json:
{
"mcpServers": {
"documentary": {
"url": "http://localhost:3027/mcp"
}
}
}
MCP_API_KEY kullaniyorsaniz headers ekleyin:
{
"mcpServers": {
"documentary": {
"url": "http://localhost:3027/mcp",
"headers": {
"API_KEY": "your-secret-key"
}
}
}
}
Installing Documentary Server
This server has no published package — it is built from source. Open the repository and follow its README.
▸ github.com/CaptainSP/documentary-mcp-serverFAQ
Is Documentary Server MCP free?
Yes, Documentary Server MCP is free — one-click install via Unyly at no cost.
Does Documentary Server need an API key?
No, Documentary Server runs without API keys or environment variables.
Is Documentary Server hosted or self-hosted?
Self-hosted: the server runs locally on your machine via the install command above.
How do I install Documentary Server in Claude Desktop, Claude Code or Cursor?
Open Documentary Server on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.
Related MCPs
GitHub
PRs, issues, code search, CI status
by GitHubFilesystem
Secure file operations with configurable access controls.
Memory
Knowledge graph-based persistent memory system.
Template MCP Server
A CLI tool to create a new Model Context Protocol server project with TypeScript support, dual transport options, and an extensible structure
by mcpdotdirectCompare Documentary Server with
Not sure what to pick?
Find your stack in 60 seconds
Author?
Embed badge for your README
Browse similar
All development MCPs
