Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .cursor/rules/flagship_author.mdc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Set-up steps:
4. Issue an API key from the dashboard and put it in `.env` as `KS_API_KEY`.
5. Run: `<CORPUS_FOLDER_ID=<id> make demo-<slug>>`

Full corpus matrix: [`docs/wiki/seed-data.md`](../../docs/wiki/seed-data.md).
Full corpus matrix: [`https://github.com/knowledgestack/ks-cookbook/wiki/seed-data`](https://github.com/knowledgestack/ks-cookbook/wiki/seed-data).

## Run
<make command + override examples>
Expand Down Expand Up @@ -115,4 +115,4 @@ demo-<slug>: check-env ## <One-line description>
- [ ] System prompt includes the four invariants (see `python_clean_code.mdc`).
- [ ] Added the package to `[tool.uv.workspace].members` in the root `pyproject.toml`.
- [ ] Added the flagship to the root README's "Flagships by vertical" catalog with tags.
- [ ] Added the flagship to `docs/wiki/seed-data.md` matrix.
- [ ] Added the flagship to the [Seed data wiki page](https://github.com/knowledgestack/ks-cookbook/wiki/seed-data) matrix.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ body:
options:
- label: I've searched existing issues and this isn't a duplicate.
required: true
- label: I've verified my tenant has the expected seed data (`docs/wiki/seed-data.md`).
- label: I've verified my tenant has the expected seed data (https://github.com/knowledgestack/ks-cookbook/wiki/seed-data).
required: true
- label: I've redacted API keys and PII from any logs / snippets.
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ contact_links:
url: https://github.com/knowledgestack/ks-cookbook/security/advisories/new
about: Found a security issue? Please report it privately instead of opening a public issue.
- name: πŸ“– Developer wiki
url: https://github.com/knowledgestack/ks-cookbook/tree/main/docs/wiki
url: https://github.com/knowledgestack/ks-cookbook/wiki
about: Connecting, MCP tools, seed data, writing flagships and recipes, troubleshooting.
- name: 🌐 Knowledge Stack docs
url: https://knowledgestack.ai
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs_improvement.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ body:
id: page
attributes:
label: Which page / file?
placeholder: "docs/wiki/seed-data.md β€” or β€” flagships/kyc_onboarding_review/README.md"
placeholder: "https://github.com/knowledgestack/ks-cookbook/wiki/seed-data β€” or β€” flagships/kyc_onboarding_review/README.md"
validations:
required: true

Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ CORPUS_FOLDER_ID=<your-folder> make demo-<slug>
- [ ] I've read [CONTRIBUTING.md](../blob/main/CONTRIBUTING.md) and the relevant [cursor rule](../tree/main/.cursor/rules/)
- [ ] No API keys, tokens, or PII in the diff
- [ ] Every non-trivial claim in the agent output is cited (`Citation.chunk_id` or `[chunk:<uuid>]`)
- [ ] Seed-data expectations documented (either in the flagship README or updating `docs/wiki/seed-data.md`)
- [ ] Seed-data expectations documented (either in the flagship README or updating the [Seed data wiki page](https://github.com/knowledgestack/ks-cookbook/wiki/seed-data))
- [ ] Workspace `pyproject.toml` updated if a new package was added
- [ ] Makefile target added/updated if a new flagship was added
- [ ] CHANGELOG.md updated under `[Unreleased]`
Expand Down
47 changes: 0 additions & 47 deletions .github/workflows/wiki.yml

This file was deleted.

3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,8 @@ fix: ## Auto-fix lint issues across the workspace
format: ## Format code with ruff
@uv run ruff format .

tags: ## Sync flagship tags into pyproject keywords + regenerate the wiki book.
tags: ## Sync flagship tags into pyproject keywords (source of truth).
@uv run python scripts/sync_flagship_tags.py
@uv run python scripts/build_wiki_book.py

tags-check: ## Fail if any flagship is missing or stale on tags (CI).
@uv run python scripts/sync_flagship_tags.py --check
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,34 @@
[![Flagships](https://img.shields.io/badge/flagships-32-green)](flagships/)
[![Recipes](https://img.shields.io/badge/recipes-100%2B-green)](recipes/)
[![MCP compatible](https://img.shields.io/badge/MCP-compatible-purple)](https://modelcontextprotocol.io/)
[![LangChain](https://img.shields.io/badge/LangChain-supported-brightgreen)](docs/wiki/frameworks/langchain.md)
[![LangGraph](https://img.shields.io/badge/LangGraph-supported-brightgreen)](docs/wiki/frameworks/langgraph.md)
[![CrewAI](https://img.shields.io/badge/CrewAI-supported-brightgreen)](docs/wiki/frameworks/crewai.md)
[![Temporal](https://img.shields.io/badge/Temporal-supported-brightgreen)](docs/wiki/frameworks/temporal.md)
[![LangChain](https://img.shields.io/badge/LangChain-supported-brightgreen)](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/langchain)
[![LangGraph](https://img.shields.io/badge/LangGraph-supported-brightgreen)](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/langgraph)
[![CrewAI](https://img.shields.io/badge/CrewAI-supported-brightgreen)](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/crewai)
[![Temporal](https://img.shields.io/badge/Temporal-supported-brightgreen)](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/temporal)

[**Quickstart**](docs/wiki/quickstart.md) Β· [**Flagships**](#flagships-by-vertical) Β· [**Frameworks**](docs/wiki/frameworks.md) Β· [**Wiki**](docs/wiki/README.md) Β· [**Discord**](https://discord.gg/McHmxUeS)
[**Quickstart**](https://github.com/knowledgestack/ks-cookbook/wiki/quickstart) Β· [**Flagships**](#flagships-by-vertical) Β· [**Frameworks**](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks) Β· [**Wiki**](https://github.com/knowledgestack/ks-cookbook/wiki) Β· [**Discord**](https://discord.gg/McHmxUeS)

</div>

---

Knowledge Stack is the document intelligence layer behind your agents β€” ingestion, chunking, permissions, versioning, citations β€” exposed as a stable **MCP** surface that plugs into [LangChain](docs/wiki/frameworks/langchain.md), [LangGraph](docs/wiki/frameworks/langgraph.md), [CrewAI](docs/wiki/frameworks/crewai.md), [Temporal](docs/wiki/frameworks/temporal.md), [OpenAI Agents SDK](docs/wiki/frameworks/openai-agents.md), [pydantic-ai](docs/wiki/frameworks/pydantic-ai.md), [Claude Desktop](docs/wiki/frameworks/claude-desktop.md), [Cursor](docs/wiki/frameworks/claude-desktop.md), and anything else that speaks [MCP](https://modelcontextprotocol.io/). **Every flagship runs under every framework** β€” pick your runtime and the [framework page](docs/wiki/frameworks.md) shows the same flagship ported end-to-end.
Knowledge Stack is the document intelligence layer behind your agents β€” ingestion, chunking, permissions, versioning, citations β€” exposed as a stable **MCP** surface that plugs into [LangChain](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/langchain), [LangGraph](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/langgraph), [CrewAI](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/crewai), [Temporal](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/temporal), [OpenAI Agents SDK](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/openai-agents), [pydantic-ai](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/pydantic-ai), [Claude Desktop](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/claude-desktop), [Cursor](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/claude-desktop), and anything else that speaks [MCP](https://modelcontextprotocol.io/). **Every flagship runs under every framework** β€” pick your runtime and the [framework page](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks) shows the same flagship ported end-to-end.

You focus on agent logic. KS manages the knowledge layer.

β†’ **New here?** Read the [Overview](docs/wiki/overview.md) (why this exists, mental model). Then run the [Quickstart](docs/wiki/quickstart.md).
β†’ **New here?** Read the [Overview](https://github.com/knowledgestack/ks-cookbook/wiki/overview) (why this exists, mental model). Then run the [Quickstart](https://github.com/knowledgestack/ks-cookbook/wiki/quickstart).

## Index

- πŸš€ [Quickstart](docs/wiki/quickstart.md) β€” `git clone` β†’ first recipe in ~5 min
- πŸ“– [Cookbook book](docs/wiki/book/README.md) β€” every flagship + recipe README assembled into one navigable book ([flagships](docs/wiki/book/flagships.md) Β· [recipes](docs/wiki/book/recipes.md))
- 🧠 [Overview & mental model](docs/wiki/overview.md) β€” what KS manages, pipeline diagram, repo map
- πŸ”Œ [Framework integrations](docs/wiki/frameworks.md) β€” every flagship runs under every framework. Worked ports:<br/>&nbsp;&nbsp;&nbsp;&nbsp;[pydantic-ai](docs/wiki/frameworks/pydantic-ai.md) Β· [LangChain](docs/wiki/frameworks/langchain.md) Β· [LangGraph](docs/wiki/frameworks/langgraph.md) Β· [CrewAI](docs/wiki/frameworks/crewai.md) Β· [OpenAI Agents SDK](docs/wiki/frameworks/openai-agents.md) Β· [Temporal](docs/wiki/frameworks/temporal.md) Β· [Claude Desktop & Cursor](docs/wiki/frameworks/claude-desktop.md) Β· [Custom MCP](docs/wiki/frameworks/custom-mcp.md)
- πŸ›  [MCP tool reference](docs/wiki/mcp-tools.md) β€” the 10 read-only tools your agent is allowed to call
- βš™οΈ [Configuration](docs/wiki/configuration.md) β€” env vars, per-demo overrides, base URLs
- πŸ“¦ [Seed data](docs/wiki/seed-data.md) β€” what each flagship expects in your tenant
- ✍️ [Writing a flagship](docs/wiki/writing-a-flagship.md) · [Writing a recipe](docs/wiki/writing-a-recipe.md)
- 🩺 [Troubleshooting](docs/wiki/troubleshooting.md)
- πŸš€ [Quickstart](https://github.com/knowledgestack/ks-cookbook/wiki/quickstart) β€” `git clone` β†’ first recipe in ~5 min
- πŸ“– [Cookbook book](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships) β€” every flagship + recipe README assembled into one navigable book ([flagships](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships) Β· [recipes](https://github.com/knowledgestack/ks-cookbook/wiki/book/recipes))
- 🧠 [Overview & mental model](https://github.com/knowledgestack/ks-cookbook/wiki/overview) β€” what KS manages, pipeline diagram, repo map
- πŸ”Œ [Framework integrations](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks) β€” every flagship runs under every framework. Worked ports:<br/>&nbsp;&nbsp;&nbsp;&nbsp;[pydantic-ai](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/pydantic-ai) Β· [LangChain](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/langchain) Β· [LangGraph](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/langgraph) Β· [CrewAI](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/crewai) Β· [OpenAI Agents SDK](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/openai-agents) Β· [Temporal](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/temporal) Β· [Claude Desktop & Cursor](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/claude-desktop) Β· [Custom MCP](https://github.com/knowledgestack/ks-cookbook/wiki/frameworks/custom-mcp)
- πŸ›  [MCP tool reference](https://github.com/knowledgestack/ks-cookbook/wiki/mcp-tools) β€” the 10 read-only tools your agent is allowed to call
- βš™οΈ [Configuration](https://github.com/knowledgestack/ks-cookbook/wiki/configuration) β€” env vars, per-demo overrides, base URLs
- πŸ“¦ [Seed data](https://github.com/knowledgestack/ks-cookbook/wiki/seed-data) β€” what each flagship expects in your tenant
- ✍️ [Writing a flagship](https://github.com/knowledgestack/ks-cookbook/wiki/writing-a-flagship) · [Writing a recipe](https://github.com/knowledgestack/ks-cookbook/wiki/writing-a-recipe)
- 🩺 [Troubleshooting](https://github.com/knowledgestack/ks-cookbook/wiki/troubleshooting)
- 🀝 [Contributing](CONTRIBUTING.md) · [Industries roadmap](INDUSTRIES.md)

## Flagships by vertical
Expand Down Expand Up @@ -114,13 +114,13 @@ Jump to: [Banking](#banking--financial-services) Β· [Legal](#legal) Β· [Accounti

## Browse by tag

Tags are first-class metadata declared in each flagship's `pyproject.toml` `[project] keywords`. The full tag index β€” every flagship grouped by tag, with anchor links into the wiki book β€” lives at **[`docs/wiki/book/flagships-by-tag.md`](docs/wiki/book/flagships-by-tag.md)**.
Tags are first-class metadata declared in each flagship's `pyproject.toml` `[project] keywords`. The full tag index β€” every flagship grouped by tag, with anchor links into the wiki book β€” lives at **[`https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag)**.

Quick jumps:

[`banking`](docs/wiki/book/flagships-by-tag.md#banking) Β· [`legal`](docs/wiki/book/flagships-by-tag.md#legal) Β· [`accounting`](docs/wiki/book/flagships-by-tag.md#accounting) Β· [`tax`](docs/wiki/book/flagships-by-tag.md#tax) Β· [`healthcare`](docs/wiki/book/flagships-by-tag.md#healthcare) Β· [`insurance`](docs/wiki/book/flagships-by-tag.md#insurance) Β· [`real-estate`](docs/wiki/book/flagships-by-tag.md#real-estate) Β· [`sales`](docs/wiki/book/flagships-by-tag.md#sales) Β· [`hr`](docs/wiki/book/flagships-by-tag.md#hr) Β· [`engineering`](docs/wiki/book/flagships-by-tag.md#engineering) Β· [`compliance`](docs/wiki/book/flagships-by-tag.md#compliance) Β· [`security`](docs/wiki/book/flagships-by-tag.md#security) Β· [`government`](docs/wiki/book/flagships-by-tag.md#government) Β· [`pharma`](docs/wiki/book/flagships-by-tag.md#pharma) Β· [`energy`](docs/wiki/book/flagships-by-tag.md#energy)
[`banking`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#banking) Β· [`legal`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#legal) Β· [`accounting`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#accounting) Β· [`tax`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#tax) Β· [`healthcare`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#healthcare) Β· [`insurance`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#insurance) Β· [`real-estate`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#real-estate) Β· [`sales`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#sales) Β· [`hr`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#hr) Β· [`engineering`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#engineering) Β· [`compliance`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#compliance) Β· [`security`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#security) Β· [`government`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#government) Β· [`pharma`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#pharma) Β· [`energy`](https://github.com/knowledgestack/ks-cookbook/wiki/book/flagships-by-tag#energy)

To **add or change tags on a flagship**: edit `keywords = [...]` in its `pyproject.toml`, then run `uv run python scripts/sync_flagship_tags.py && uv run python scripts/build_wiki_book.py`. See [Writing a flagship β†’ Tagging](docs/wiki/writing-a-flagship.md#tagging).
To **add or change tags on a flagship**: edit `keywords = [...]` in its `pyproject.toml`, then run `make tags`. See [Writing a flagship β†’ Tagging](https://github.com/knowledgestack/ks-cookbook/wiki/writing-a-flagship#tagging).

See [INDUSTRIES.md](INDUSTRIES.md) for the broader roadmap and proposed next flagships.

Expand Down
Loading
Loading