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
30 changes: 16 additions & 14 deletions README.ko.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# AI Agent Context Hub — Phase 1 (로컬 MCP 프로토타입)
# AI Agent Context Hub

[![CI](https://github.com/junseo2323/claudexhub/actions/workflows/ci.yml/badge.svg)](https://github.com/junseo2323/claudexhub/actions/workflows/ci.yml)

[English README](./README.md)

**에이전트 중심 개발자 지식 플랫폼**입니다. AI 코딩 에이전트(Claude Code,
Codex, Cursor)가 MCP 서버를 통해 구조화된 문제 해결 단위인 **Context Card**를
Codex, Cursor, Antigravity)가 MCP 서버를 통해 구조화된 문제 해결 단위인 **Context Card**를
읽고 씁니다. 한 번 해결한 문제를 처음부터 다시 분석하는 대신, 나중에 검색하여
재사용할 수 있습니다.

이 저장소는 **Phase 1**으로, Claude Code에 연결할 수 있는 stdio MCP 서버와
동일한 데이터를 보여주는 **웹 앱**을 중심으로 한 로컬 우선 프로토타입입니다.
모든 데이터는 로컬 SQLite 저장소를 사용합니다.
호스팅 Hub는 GitHub 로그인, API 토큰, 원격 MCP 엔드포인트와 함께 공유된
엔지니어링 지식을 검색·검토·게시하는 웹 앱을 제공합니다.

## 구성 요소

> 📄 제품 명세: [`docs/PLANNING.md`](./docs/PLANNING.md) · 명세와 구현 차이 분석:
> [`docs/SPEC-GAP.md`](./docs/SPEC-GAP.md)

- stdio 방식으로 7개 도구를 제공하는 **MCP 서버** (`src/index.ts`)
- 호스팅 HTTP와 로컬 stdio 방식으로 7개 도구를 제공하는 **MCP 서버**
- FTS5 키워드 검색과 sqlite-vec 임베딩 유사도를 신뢰도 점수로 결합하는
**하이브리드 검색** 기반의 **로컬 SQLite** 저장소
- **요약 우선 검색**: `search_context`는 간결한 요약만 반환하며, 토큰 절약을
Expand All @@ -43,18 +42,21 @@ Codex, Cursor)가 MCP 서버를 통해 구조화된 문제 해결 단위인 **Co
| `record_feedback` | 재사용 결과(`success`, `partial`, `failed`)를 기록하고 재사용 횟수, 누적 절약 토큰, 신뢰도를 갱신합니다. |
| `mark_stale` | 해결책이 오래되었거나 잘못된 경우 카드를 오래된 상태로 표시합니다. 오래된 카드는 검색 결과에서 제외됩니다. |

## 빠른 시작
## 에이전트 연결

배포된 MCP 서버를 `npx`로 실행할 수 있습니다. 아래 명령 하나로 로컬 DB
스키마와 시드 카드를 준비한 다음 에이전트에 연결하세요.
명령어 한 줄을 실행하세요. GitHub 로그인을 위한 브라우저가 열리고, CLI가
호스팅 API 토큰을 만든 뒤 Context Hub를 자동 등록합니다.

```bash
npx -y ai-agent-context-hub context-hub-cli init # 스키마 + 시드 카드 20개
npx -y ai-agent-context-hub connect claude
npx -y ai-agent-context-hub connect codex
npx -y ai-agent-context-hub connect cursor
npx -y ai-agent-context-hub connect antigravity
```

바로 복사해 쓸 수 있는 Claude Code와 Cursor 설정은
[`examples/`](./examples)에 있습니다. 패키지는 `context-hub`(기본 MCP 서버)와
`context-hub-cli`(개발/관리 CLI), 두 개의 실행 파일을 제공합니다.
지원되는 에이전트를 모두 설정하려면 `connect all`을 사용하세요. JSON 편집이나
로컬 DB 설정은 필요 없습니다. 자세한 사용법은
[claudexhub.fly.dev](https://claudexhub.fly.dev/)에서 확인할 수 있습니다.

## 소스에서 설치

Expand Down Expand Up @@ -93,7 +95,7 @@ npm run cli -- eval --k 5 # 검색 품질 자체 검색 평가(hit@k,
npm run cli -- reindex
```

## Claude Code에 등록
## 로컬 개발: Claude Code에 등록

이 저장소에는 프로젝트 범위의 `.mcp.json`이 포함되어 있습니다.

Expand Down
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
# AI Agent Context Hub — Phase 1 (Local MCP Prototype)
# AI Agent Context Hub

[![CI](https://github.com/junseo2323/claudexhub/actions/workflows/ci.yml/badge.svg)](https://github.com/junseo2323/claudexhub/actions/workflows/ci.yml)

[한국어 README](./README.ko.md)

An **agent-first developer knowledge platform**. AI coding agents (Claude Code,
Codex, Cursor) read and write **Context Cards** — structured problem-solving
Codex, Cursor, Antigravity) read and write **Context Cards** — structured problem-solving
units — through an MCP server, so a fix solved once can be searched and reused
later instead of re-derived from scratch.

This repository is **Phase 1**: a local-first prototype centered on a stdio MCP
server you can plug into Claude Code, plus a read-only **web view** over the same
data. No OAuth or hosted endpoint yet — everything runs against a local SQLite store.
The hosted Hub provides GitHub sign-in, API tokens, a remote MCP endpoint, and a
web app for searching, reviewing, and publishing shared engineering knowledge.

## What's here

> 📄 Product spec: [`docs/PLANNING.md`](./docs/PLANNING.md) · spec-vs-build gap
> analysis: [`docs/SPEC-GAP.md`](./docs/SPEC-GAP.md).

- **MCP server** (`src/index.ts`) exposing 7 tools over stdio.
- **MCP server** exposing 7 tools over hosted HTTP and local stdio.
- **Local SQLite** store with **hybrid search**: FTS5 keyword + sqlite-vec
embedding similarity, fused into a confidence score.
- **Brief-first retrieval**: `search_context` returns compact briefs; full card
Expand All @@ -27,8 +26,8 @@ data. No OAuth or hosted endpoint yet — everything runs against a local SQLite
card is stored or published.
- **Human approval**: agents create *drafts*; publishing requires an explicit
approval step.
- A **read-only web app** (`app/`, Next.js) — dashboard, leaderboard/stats, card
browse, detail, and search — reusing the exact same domain layer.
- A **web app** (`app/`, Next.js) for authentication, tokens, card authoring,
review, search, teams, profiles, and operational status.
- A **dev CLI** and **seed data** (20 example cards).

## MCP tools
Expand All @@ -43,18 +42,21 @@ data. No OAuth or hosted endpoint yet — everything runs against a local SQLite
| `record_feedback` | Record reuse outcome (success/partial/failed); updates reuse counts, accumulated tokens saved, and confidence. |
| `mark_stale` | Mark a card stale when its fix is outdated/wrong; stale cards drop out of search. |

## Quickstart
## Connect an agent

Run the published MCP server with `npx` — one command sets up the local DB
(schema + seed cards), then point your agent at it:
Run one command. A browser opens for GitHub sign-in, then the CLI creates a
hosted API token and registers Context Hub automatically:

```bash
npx -y ai-agent-context-hub context-hub-cli init # schema + 20 seed cards
npx -y ai-agent-context-hub connect claude
npx -y ai-agent-context-hub connect codex
npx -y ai-agent-context-hub connect cursor
npx -y ai-agent-context-hub connect antigravity
```

Ready-to-copy agent configs are in [`examples/`](./examples) (Claude Code, Cursor).
The package ships two bins: `context-hub` (the MCP server, the default) and
`context-hub-cli` (the dev/admin CLI).
Use `connect all` to configure every supported agent. No JSON editing or local
database setup is required. See the live guide at
[claudexhub.fly.dev](https://claudexhub.fly.dev/).

## Setup (from source)

Expand Down Expand Up @@ -92,7 +94,7 @@ npm run cli -- eval --k 5 # search-quality self-retrieval eval (hit@k
npm run cli -- reindex
```

## Register in Claude Code
## Local development: register in Claude Code

This repo ships a project-scoped `.mcp.json`:

Expand Down
Loading