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

https://github.com/mattslight/oyster

A modern OS for knowledge work powered by LLM — connect your projects, control everything from a prompt / MCP
https://github.com/mattslight/oyster

ai developer-tools knowledge-management mcp operating-system os workspace

Last synced: about 1 month ago
JSON representation

A modern OS for knowledge work powered by LLM — connect your projects, control everything from a prompt / MCP

Awesome Lists containing this project

README

          

Oyster — From prompt to workspace

[![Release](https://img.shields.io/github/v/release/mattslight/oyster?color=7c6bff)](https://github.com/mattslight/oyster/releases)
[![npm](https://img.shields.io/npm/v/oyster-os?color=7c6bff)](https://www.npmjs.com/package/oyster-os)
[![Downloads](https://img.shields.io/npm/dm/oyster-os?color=7c6bff)](https://www.npmjs.com/package/oyster-os)
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux%20%7C%20Windows-7c6bff)]()
[![License](https://img.shields.io/badge/License-AGPL--3.0-7c6bff)](LICENSE)

---

**🦪 Every agent, one shared brain.** Oyster watches your AI sessions, captures the files they touched and the memories they wrote, and brings them all into one workspace — visible, searchable, persistent across every machine. Built on MCP.

```bash
# 1. Install
npm install -g oyster-os

# 2. Start
oyster

# 3. Open your browser to http://localhost:4444
```

## Why Oyster

Your AI sessions, files, and memories live in tool-shaped silos. Oyster puts every agent's work on one shared surface, organised by space.

- **See every agent at work** — Oyster watches Claude Code automatically. Live transcripts, status (active / awaiting / disconnected / done), and the files each session touched, all on Home.
- **Memory that survives sessions** — `remember` notes are first-class. Every agent's `recall` reads from the same store, so context follows you across tools and machines.
- **Drop in any project** — point Oyster at a folder and it scans for documents, apps, and diagrams, then attributes future sessions back to the right project.
- **Bring any agent** — Oyster is an MCP server. Claude Code, Cursor, VS Code, Windsurf, or your own — one standard, every agent.

## Quick Start

```bash
npm install -g oyster-os
oyster
```

That's it. On first run, Oyster connects you to an AI provider (opens your browser to sign in). Then your workspace opens at **http://localhost:4444**.

Or try without installing:

```bash
npx oyster-os
```

## Connect Your AI

Oyster is an MCP server. Any MCP-compatible tool can connect and control your workspace.

**Claude Code:**

```bash
claude mcp add --scope user --transport http oyster http://localhost:4444/mcp/
```

**Cursor / VS Code / other MCP clients** — add to your MCP config:

```json
{
"oyster": {
"type": "http",
"url": "http://localhost:4444/mcp/"
}
}
```

Once connected, your AI can list spaces, open artefacts, create documents, onboard projects, and manage the surface directly.

## Onboard a Project

From the Oyster chat bar:

```
onboard my project at ~/Dev/my-project
```

Oyster scans the folder for documents, apps, and diagrams and adds them to the surface automatically.

## Commands

| Command | What it does |
|---|---|
| `/s ` | Switch to a space — `/s blunderfixer` opens that space |
| `/o ` | Open an artefact by name — `/o pricing deck` finds and opens it |
| `#` | Quick space switch — `#home` goes home, `#bf` matches blunderfixer |
| `#` | Jump to a numbered space — `#1` switches to first space |
| `#.` | Go to the home screen |
| normal chat | Ask Oyster anything — navigate, organise, or create work |

## Architecture

```
Browser → http://localhost:4444
|
Oyster Server
- SQLite (artefacts, spaces)
- MCP server (/mcp/)
- SSE push (instant UI updates)
- Static web UI
- Chat proxy → OpenCode → LLM
```

## Status

Early v1. Local-first. Single-user. Built for fast iteration.

- **Now (`0.5.x`)** — Sessions feed (Claude Code), Memories on Home, Project tiles per space, repo onboarding, 19 MCP tools, slash commands.
- **Next (`0.6.x`)** — Bundles. Multi-file static artefacts; agents push artefacts via MCP.
- **Then (`0.7.x`)** — Oyster Pro. Auth, cross-device sync, end-to-end encrypted storage, shareable links. ([pricing](https://oyster.to/pricing))
- **Then (`0.8.x`)** — Multi-agent ingestion. Cursor, Codex, OpenCode session feeds — every agent feeds the same workspace.

See every shipped change in the [changelog](https://oyster.to/changelog).

## Contributing

Oyster is early, but focused contributions are welcome.

1. Open an issue first
2. Keep the scope tight
3. Send a focused PR with a clear before and after

### Development

```bash
git clone https://github.com/mattslight/oyster.git
cd oyster
cd web && npm install && cd ../server && npm install && cd ..
npm run dev
# → dev server at http://localhost:7337 (proxies to server at 3333)
```

## Licence

[AGPL-3.0](LICENSE)

Copyright (c) 2026 Matthew Slight

You can use, modify, and distribute this software freely. If you run a modified version as a network service, you must make your source code available under the same licence.