Skip to content

wellitongervickas/knowstack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

knowstack (beta)

License: MIT Node.js NestJS TypeScript

A self-hostable platform that connects development teams to their technical documentation through AI-native interfaces. Query specs, patterns, and guidelines directly from your IDE via the Model Context Protocol (MCP). Learn more in About.

Features

  • MCP-Native -- Model Context Protocol as the sole interface; works with any MCP-compatible IDE or AI tool
  • AI-Powered Queries -- Natural language queries against your documentation with cited answers
  • Semantic Search -- Vector embeddings for relevance-ranked document retrieval
  • Multi-Source Ingestion -- Import from local files and URLs
  • Multi-Tenant Architecture -- Organizations and projects with config-driven tenant resolution
  • Local-First -- No authentication required; tenant context via HTTP headers
  • Self-Hostable -- Deploy on your own infrastructure with Docker

Quick Start

Prerequisites

  • Docker & Docker Compose
  • Node.js 20+ and pnpm

1. Clone and Install

git clone https://github.com/wellitongervickas/knowstack.git
cd knowstack
pnpm install
cp .env.example .env

2. Start Services

Option A: Docker (all-in-one)

Starts PostgreSQL, Redis, and the app server in containers.

docker compose up -d
pnpm prisma migrate deploy

Option B: Local Development (hot reload)

Starts only the database and cache in containers; run the server locally.

docker compose up -d db redis
pnpm prisma generate
pnpm prisma migrate dev

3. Seed Data

The SDK CLI creates your organization, project, ingests documentation, and seeds AI instructions. It works from any directory and prints MCP connection config at the end.

npx @knowstack/sdk --init

See the SDK Setup Guide for full options including named profiles.

4. Start and Connect

Option A: The server is already running at http://localhost:3100.

Option B: Start the server:

pnpm start:dev

Use the MCP config printed by the SDK to connect your IDE. See MCP Integration below.

MCP Integration

KnowStack exposes MCP tools for document queries, search, instruction retrieval, and memory management. See the MCP Reference for details.

Claude Code:

claude mcp add knowstack \
  --transport http http://localhost:3100/api/v1/mcp \
  -H "x-ks-org: your-org-slug" \
  -H "x-ks-project: your-project-slug"

VS Code / Cursor (.vscode/mcp.json):

{
  "servers": {
    "knowstack": {
      "type": "http",
      "url": "http://localhost:3100/api/v1/mcp",
      "headers": {
        "x-ks-org": "your-org-slug",
        "x-ks-project": "your-project-slug"
      }
    }
  }
}

Common Scripts

Script Description
npx @knowstack/sdk --init Interactive setup wizard (org, project, docs)
pnpm start:dev Start development server with hot reload
pnpm start:debug Start with debugger attached
pnpm build Build for production
pnpm start:prod Run production build
pnpm prisma studio Open Prisma database GUI
pnpm prisma migrate dev Run database migrations
pnpm test Run unit tests

Documentation

Contributing

Contributions are welcome! Please read our Contributing Guide before submitting a PR.

Security

To report a security vulnerability, please open a private issue on GitHub. See SECURITY.md for details.

License

This project is licensed under the MIT License. See LICENSE for details.

About

A self-hostable platform that connects development teams to their technical documentation through AI-native interfaces. Query specs, patterns, and guidelines directly from your IDE via the Model Context Protocol (MCP).

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages