Skip to content

Commit 12bf508

Browse files
authored
docs: add examples/README.md, broaden the root README's examples intro (#157)
examples/README.md was missing entirely. Add it as an index explaining the shared theme across the three examples: each replicates a well-known project on top of MFS, in a fraction of the code, because MFS already owns ingestion/embedding/vector-store/search. The root README's examples section only talked about Open Tag (a leftover from before deep-research-skill and claude-context existed). Reworded it to state that shared theme up front and list all three examples evenly instead of spotlighting one. Signed-off-by: Cheney Zhang <chen.zhang@zilliz.com>
1 parent 96425fa commit 12bf508

2 files changed

Lines changed: 47 additions & 14 deletions

File tree

README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -739,23 +739,33 @@ at MFS and focus on the app on top.
739739
- **CLI** — call the `mfs` command to build your own **skills**, **MCP servers**,
740740
or **plugins** on top of the same surface.
741741

742-
One example is [`Open Tag`](examples/open-tag-skill/): a small open-source Slack
743-
bot you `@mention``@OpenClaude` or `@OpenCodex` — that gathers authorized
744-
context and runs the task on a CLI agent backend. It's an open, self-hosted homage
745-
to [Claude Tag](https://www.anthropic.com/news/introducing-claude-tag), Anthropic's
746-
hosted `@Claude` Slack teammate. The point is how little it takes to build: MFS already gives it one
747-
searchable, self-hosted memory over Slack, repos, docs, issues, and databases, so
748-
its strongest capability — plugging in whatever data sources you need — is also
749-
the easy part. See the [example](examples/open-tag-skill/) for the full walkthrough.
742+
### 🧩 Examples: well-known projects, rebuilt on MFS
743+
744+
Every example under [`examples/`](examples/) replicates a well-known project on
745+
top of MFS — the same capability, in a fraction of the code — because MFS
746+
already owns the part that used to be the hard part for each of them:
747+
ingestion, chunking, embedding, the vector store, and hybrid search across many
748+
source types. What's left is thin glue, or a single skill describing a strategy.
749+
750+
- [`claude-context`](examples/claude-context/) — a replica of
751+
[claude-context](https://github.com/zilliztech/claude-context) ("make the
752+
codebase the context for any coding agent"): an MCP server exposing
753+
`search` + `read` over MFS, about 60 lines.
754+
- [`deep-research-skill`](examples/deep-research-skill/) — the "reason and
755+
search over private data" job [deep-searcher](https://github.com/zilliztech/deep-searcher)
756+
does as a standalone framework, done here as a single skill on top of
757+
`mfs-find` — no vector-DB glue, no provider matrix, no custom
758+
retrieval-loop code.
759+
- [`open-tag-skill`](examples/open-tag-skill/) — a self-hosted homage to
760+
[Claude Tag](https://www.anthropic.com/news/introducing-claude-tag),
761+
Anthropic's hosted `@Claude` Slack teammate: `@mention` a bot in Slack —
762+
`@OpenClaude` or `@OpenCodex` — and it gathers authorized MFS context and
763+
runs the task on a CLI agent backend.
750764

751765
![Open Tag — delegating a PR review across Slack channels](https://github.com/user-attachments/assets/6cb1db05-dd12-4a13-a9fa-1a1bf69bcf28)
752766

753-
Another is [`Deep Research`](examples/deep-research-skill/): the "reason and
754-
search over private data" job [deep-searcher](https://github.com/zilliztech/deep-searcher)
755-
does as a standalone framework, done here as a single skill on top of `mfs-find`
756-
no vector-DB glue, no provider matrix, no custom retrieval-loop code, because MFS
757-
already indexes and searches, and an agent with a search tool already runs that
758-
loop natively once it has the strategy.
767+
See [`examples/README.md`](examples/README.md) for the full list, or each
768+
example's own README for its install command and walkthrough.
759769

760770
## 🗺️ Roadmap
761771

examples/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Examples
2+
3+
Each example here rebuilds a well-known project on top of MFS — the same
4+
capability, in a fraction of the code — because MFS already owns the part
5+
that used to be the hard part for each of them: ingestion, chunking,
6+
embedding, the vector store, and hybrid search across many source types.
7+
What's left is thin glue, or a single skill describing a strategy on top of
8+
`mfs search` / `mfs cat`.
9+
10+
| Example | Replicates | What it is |
11+
|---|---|---|
12+
| [`claude-context/`](claude-context/) | [claude-context](https://github.com/zilliztech/claude-context) — "make the codebase the context for any coding agent" | An MCP server: `search` + `read` over MFS, about 60 lines |
13+
| [`deep-research-skill/`](deep-research-skill/) | [deep-searcher](https://github.com/zilliztech/deep-searcher) — reason and search over private data | A skill (`deep-research`) that runs the decompose → search → evaluate → synthesize loop on top of `mfs-find`; no framework, no vector-DB glue |
14+
| [`open-tag-skill/`](open-tag-skill/) | [Claude Tag](https://www.anthropic.com/news/introducing-claude-tag) — Anthropic's hosted `@Claude` Slack teammate | A self-hosted Slack bot (`@OpenClaude` / `@OpenCodex`) plus the `open-tag-admin` skill that sets it up and runs it |
15+
16+
Every one of the replicated projects had to build its own retrieval stack
17+
from scratch — a provider matrix, a vector database, document loaders, sync
18+
logic. MFS already is that stack, so the example is only ever what's left
19+
on top of it: an MCP server thin enough to read in one sitting, a skill
20+
that's a strategy prompt over MFS's search API, or a small bridge process.
21+
22+
Open each example's own README for the install command and a full
23+
walkthrough.

0 commit comments

Comments
 (0)