ドキュメント
Epismo の基本概念から CLI、HTTP API、MCP サーバーまでを一通り理解するためのドキュメントです。
Epismo は、ヒトと AI エージェントが一緒に進める仕事のための共有ワークスペースです。チームがエージェントに仕事を任せるほど、2つのものが失われがちになります。エージェントがうまく動くために必要な知識と、その仕事自体の最新の状態です。Epismo はその両方に置き場所を与えます。
- 再利用する知識や手順はパックに保存します。 パックは一度作って何度も使うものです。オンボーディングガイド、レビューのチェックリスト、リサーチのまとめ、運用手順書などです。
- 進行中の作業はトラックとして管理します。 トラックは状態を持ち、完了に向かって進むものです。タスクや、進捗を持つゴールです。
同じモデルを3つのインターフェースから扱えます。CLI、HTTP API、MCP サーバー です。ターミナル、CI、プロダクトのバックエンド、AI アシスタントのいずれもが、同じ信頼できる情報源を読み書きします。特定のツールに縛られることはありません。
はじめての方は、このページの後に 基本概念 を読んでください。この2ページで、初日に多くの人が抱く3つの疑問「何を作ればよいか」「誰が見られるか」「どのインターフェースを使うか」に答えられます。
まず理解すること
Epismo のほとんどのものは、再利用する知識か、進行中の作業のどちらかです。どちらなのかを見分けるのが、最初に身につけるスキルです。
| 手元にあるもの | 作るもの | 例 | 理由 |
|---|---|---|---|
| 再利用する知識や手順 | パック | リリースレビューのチェックリスト、入社オンボーディングガイド | 他の人やエージェントが後から何度も使うため |
| 進行中の作業 | トラック | 「料金ページをレビューする」「オンボーディング v2 を公開する」 | 状態、期限、担当、依存、進捗を持つため |
迷ったときの目安です。
- 後で再利用するなら パック を作ります。
- 「完了」に到達させたいなら トラック を作ります。
- 繰り返す手順なら workflow pack、参照用の知識なら context pack です。
- 具体的な作業なら task track、進捗を追う成果なら goal track です。
5分で試す
CLI を使うと、モデルの動きを一番早く体感できます。インストールしてサインインします。
npm install -g epismo
epismo login --email you@example.com
epismo whoami再利用する知識を context pack として保存します。各ブロックは名前付きの参照セクションです。
epismo pack create --type context --title "Team onboarding" --personal \
--blocks '[{"title":"Where things live","content":"Docs in Notion, code in GitHub, designs in Figma."},{"title":"How we work","content":"Weekly planning on Mondays; ship behind feature flags."}]'作成後に返ってくるパック ID に エイリアス を付けると、生の UUID ではなく読みやすい名前で参照できます。
epismo alias upsert @team-onboarding --id $PACK_ID
epismo pack get @team-onboarding --full次に、進行中の作業を task track として作り、検索で見つけ直します。
epismo track create --type task --title "Review docs structure" --personal \
--task '{"status":"todo","dueDate":"2026-06-05"}'
epismo track search --type task --personal --filter '{"status":["todo"]}'これが Epismo の基本ループです。再利用する知識をパックとして残し、作業の実行はトラックとして進めます。
どのインターフェースを使うか
3つのインターフェースはすべて同じオブジェクトモデルを扱います。作業が起きる場所で選びます。
| インターフェース | 向いている用途 | 読むページ |
|---|---|---|
| CLI | ローカル操作、運用、CI、手早い検証 | CLI リファレンス |
| HTTP API | 自社サービスやバックエンドからの連携 | API リファレンス |
| MCP サーバー | ChatGPT、Claude など AI エージェントや MCP クライアントから利用 | MCP サーバー |
迷ったら CLI から始めてください。CLI の入力は API のリクエストボディにとても近いため、ターミナルで動いた JSON はそのまま連携の出発点になります。
オブジェクトモデル
Epismo のどこでも使う基本要素です。
| オブジェクト | 用途 | 主な項目 | 補足 |
|---|---|---|---|
| workflow pack | 繰り返し使う手順 | steps[] |
ステップごとにタイトル / 内容 / 担当者 / 依存関係を持てます。 |
| context pack | 再利用する知識ブロック | blocks[] |
オンボーディングガイド、ポリシー、リサーチなどに向きます。 |
| task track | 具体的な作業単位 | task.status, dueDate, assignee, dependsOn |
ステータスは backlog, todo, in_progress, done です。 |
| goal track | 進捗を持つ成果目標 | goal.status, progress, dueDate |
進捗は0から100の整数です。 |
| エイリアス | パックへの読みやすい参照 | @name, @handle/name |
トラックではなくパックだけを指します。 |
誰がデータを見られるか
非公開データは2か所のどちらかに置かれます。自分の 個人スペース か、ワークスペース内の1つ以上の プロジェクト です。場所は scope で選びます。
自分だけのものにする場合:
{ "scope": { "type": "personal" } }プロジェクトを通じてチームと共有する場合:
{ "scope": { "type": "projects", "ids": ["project-id"] } }早めに覚えておくとよい点が2つあります。
- 作成・更新では単一の
scopeを渡します。検索では複数の非公開な場所を一度に探せるようscopes(複数形)を渡します。 - 非公開のものを特定の人にも見せたい場合は
sharedWithにユーザー ID または email を渡します。
ワークスペース、プロジェクト、共有の詳細は 基本概念 で扱います。
全体に共通するルール
すべてのインターフェースに共通するルールがあり、本ドキュメントの例もこれに従っています。
- 日付は
YYYY-MM-DDです。任意の日付は空文字でクリアできます。 - Markdown の本文は最大65,535文字、title は必須で最大255文字です。
- 更新系はページに明記がない限り PATCH 方式です。省略した項目は現在値を維持します。
- レスポンスは JSON です。CLI では結果が stdout、警告・エラーが stderr に出ます。
次に読む
- 基本概念:オブジェクトの選び方、スコープ、共有の仕組み。
- CLI リファレンス:ターミナルからパックとトラックを作成・検索する。
- API リファレンス:HTTP でプロダクト連携を作る。
- MCP サーバー:AI エージェントや MCP クライアントを接続する。