Snipphy MCP は、ChatGPT や Claude などのMCPクライアントから Snipphy の記事・モジュールを直接操作するためのツール群です。記事作成だけでなく、一覧取得、本文取得、更新、複製、削除、モジュールへの紐付け、並び替えまで一通り扱えます。
get_article_markdown で現在の本文を取得してから update_markdown_article で全体置換するのが基本現在の Snipphy MCP では、記事操作・モジュール操作・Markdownガイド取得を含む複数のツールが提供されています。まずは一覧取得系ツールで ID や slug を確認してから、作成・更新・削除系ツールを使います。
| ツール名 | カテゴリ | 概要 |
|---|---|---|
get_markdown_format_guide | ガイド | Snipphy 推奨の Markdown 構成・見出しルールを取得 |
create_markdown_article | 記事 | Markdown から新規記事を作成 |
list_my_articles | 記事 | 自分の記事一覧を検索・取得 |
list_unassigned_articles | 記事 | どのモジュールにも紐付いていない記事を取得 |
get_article_markdown | 記事 | 既存記事の Markdown 本文を取得 |
update_markdown_article | 記事 | 既存記事の本文・タグ・ステータス・タイトルを更新 |
delete_markdown_article | 記事 | 既存記事を削除 |
duplicate_markdown_article | 記事 | 既存記事を複製 |
bulk_update_article_status | 記事 | 複数記事のステータスを一括変更 |
create_module | モジュール | 新規モジュールを作成 |
list_my_modules | モジュール | 自分のモジュール一覧を取得 |
get_module_logic_tree | モジュール | モジュール構造と記事順を取得 |
attach_article_to_module | モジュール | 既存記事をモジュールに追加 |
detach_article_from_module | モジュール | 記事をモジュールから外す |
reorder_module_articles | モジュール | モジュール内の記事順を変更 |
delete_module | モジュール | モジュールを削除 |
記事系ツールは、Snipphyの記事を作る・探す・読む・直す・整理するための中心機能です。更新系ツールは全体置換になるため、編集前の取得が重要です。
create_markdown_article — 記事の作成Markdown本文を渡すと、Snipphyに新規記事を作成します。module_slug を指定すると、作成と同時にモジュールへ追加できます。
| パラメータ | 必須 | 説明 |
|---|---|---|
title | — | 記事タイトル。省略時は Snipphy 側で生成 |
markdown | ✅ | Markdown 形式の本文 |
tags | — | タグ名の配列。省略時は内容から自動生成される場合がある |
status | — | draft / private / published。デフォルトは draft |
module_slug | — | 紐付け先モジュールの slug |
記事タイトルは
titleフィールドに入れ、Markdown本文の先頭に同じタイトルの#見出しを置かないのが推奨です。
list_my_articles — 記事一覧の取得自分の記事を検索・一覧表示します。編集や紐付けに必要な article ID / slug を調べるときに使います。
| パラメータ | 必須 | 説明 |
|---|---|---|
query | — | タイトル検索テキスト |
status | — | all / draft / private / published |
tag | — | 完全一致のタグ名で絞り込み |
limit | — | 取得件数。最大100 |
list_unassigned_articles — 未所属記事の取得どのモジュールにも紐付いていない記事を一覧取得します。記事をモジュールへ整理したいときに便利です。
| パラメータ | 必須 | 説明 |
|---|---|---|
query | — | タイトル検索テキスト |
status | — | all / draft / private / published |
tag | — | 完全一致のタグ名で絞り込み |
limit | — | 取得件数。最大100 |
get_article_markdown — 記事本文の取得既存記事の Markdown 本文を取得します。update_markdown_article は本文を全体置換するため、編集前に必ず確認するのが安全です。
| パラメータ | 必須 | 説明 |
|---|---|---|
article_id | ✅ * | 記事 ID。slug とどちらか必須 |
slug | ✅ * | 記事 slug。article_id とどちらか必須 |
update_markdown_article — 記事の更新既存記事の Markdown 本文、タグ、ステータス、タイトルを更新します。本文を渡す場合は全体置換になります。
| パラメータ | 必須 | 説明 |
|---|---|---|
article_id | ✅ * | 記事 ID。slug とどちらか必須 |
slug | ✅ * | 記事 slug。article_id とどちらか必須 |
title | — | 新しいタイトル。通常編集では省略して既存タイトルを維持 |
markdown | — | 新しい Markdown 本文。指定すると全体置換 |
tags | — | 新しいタグ一覧。指定すると全体置換 |
status | — | draft / private / published |
⚠️ 部分編集したい場合でも、ツールには最終的な全文 Markdown を渡します。既存本文を取得してから差分を反映してください。
duplicate_markdown_article — 記事の複製既存記事を複製し、下書きまたは指定ステータスの記事として保存します。必要に応じてモジュールにも追加できます。
| パラメータ | 必須 | 説明 |
|---|---|---|
article_id | ✅ * | 複製元の記事 ID。slug とどちらか必須 |
slug | ✅ * | 複製元の記事 slug。article_id とどちらか必須 |
title | — | 複製後の記事タイトル |
status | — | draft / private / published。デフォルトは draft |
module_slug | — | 複製記事を追加するモジュール slug |
delete_markdown_article — 記事の削除既存記事を削除します。破壊的な操作のため、confirm: true が必須です。
| パラメータ | 必須 | 説明 |
|---|---|---|
article_id | ✅ * | 削除対象の記事 ID。slug とどちらか必須 |
slug | ✅ * | 削除対象の記事 slug。article_id とどちらか必須 |
confirm | ✅ | 削除確認。true が必要 |
bulk_update_article_status — 複数記事のステータス変更複数の記事をまとめて draft / private / published に変更します。公開前後の整理に使えます。
| パラメータ | 必須 | 説明 |
|---|---|---|
article_ids | ✅ | 対象記事 ID の配列 |
status | ✅ | 変更後ステータス。draft / private / published |
モジュール系ツールは、記事を体系化して学習コンテンツやガイドとしてまとめるための機能です。記事の追加・解除・並び替えを行う前に、現在の構造を確認するのが基本です。
create_module — モジュールの作成複数記事をまとめるモジュールを新規作成します。作成後に返される slug を記事作成や紐付けで使います。
| パラメータ | 必須 | 説明 |
|---|---|---|
title | ✅ | モジュールタイトル |
description | — | 短い説明文 |
icon | — | アイコンキー。デフォルトは document |
status | — | draft |
list_my_modules — モジュール一覧の取得自分のモジュール一覧を取得します。モジュールの slug を調べるときに使います。
| パラメータ | 必須 | 説明 |
|---|---|---|
query | — | タイトル検索テキスト |
status | — | all / draft / published |
limit | — | 取得件数。最大100 |
get_module_logic_tree — モジュール構造の取得モジュール内の記事順、記事ID、見出し構造を確認します。include_markdown: true にすると各記事の本文も取得できます。
| パラメータ | 必須 | 説明 |
|---|---|---|
module_slug | ✅ | モジュール slug |
include_markdown | — | 記事本文も含めるか。デフォルトは false |
attach_article_to_module — 既存記事をモジュールに追加既存記事を指定モジュールに紐付けます。未所属記事を整理したり、既存記事をガイドに組み込むときに使います。
| パラメータ | 必須 | 説明 |
|---|---|---|
module_slug | ✅ | 追加先モジュール slug |
article_id | ✅ * | 記事 ID。article_slug とどちらか必須 |
article_slug | ✅ * | 記事 slug。article_id とどちらか必須 |
position | — | 挿入位置。0始まり。省略時は末尾 |
detach_article_from_module — モジュールから記事を外す記事そのものは削除せず、指定モジュールとの紐付けだけを解除します。
| パラメータ | 必須 | 説明 |
|---|---|---|
module_slug | ✅ | 対象モジュール slug |
article_id | ✅ * | 記事 ID。article_slug とどちらか必須 |
article_slug | ✅ * | 記事 slug。article_id とどちらか必須 |
reorder_module_articles — モジュール内の記事順を変更モジュール内の記事を指定した順序に並び替えます。指定しなかった記事は、指定した記事の後ろに残ります。
| パラメータ | 必須 | 説明 |
|---|---|---|
module_slug | ✅ | モジュール slug |
article_ids | ✅ | 希望順に並べた記事 ID の配列 |
delete_module — モジュールの削除モジュールを削除します。記事そのものは削除されませんが、モジュールと記事のリンクは消えます。破壊的操作のため confirm: true が必要です。
| パラメータ | 必須 | 説明 |
|---|---|---|
module_slug | ✅ | 削除対象モジュール slug |
confirm | ✅ | 削除確認。true が必要 |
Markdown を Snipphy に適した構造で書くための補助ツールです。記事を新規作成・更新する前に参照すると、ロジックツリー化しやすい本文になります。
get_markdown_format_guide — Markdown フォーマットガイドの取得Snipphy 推奨の見出しルール、キーメッセージの書き方、記事タイトルの扱いを取得します。
主なルール:
title フィールドに入れ、Markdown本文の先頭に同じタイトルを置かない# は記事内のトップレベルセクション## はサブセクション# セクションを 概要 にするのが推奨Snipphy MCP は、最初に一覧・構造を確認し、その後に作成・更新・整理を行う流れで使うと安全です。
1. list_my_modules で追加先モジュールの slug を確認
2. get_markdown_format_guide で Markdown 構成を確認
3. create_markdown_article に markdown と module_slug を指定して作成
1. list_my_articles で対象記事の ID / slug を確認
2. get_article_markdown で現在の本文を取得
3. 本文を編集して最終版 Markdown を作成
4. update_markdown_article に markdown を渡して更新
1. list_unassigned_articles で未所属記事を確認
2. list_my_modules で追加先モジュールを確認
3. attach_article_to_module で記事をモジュールに追加
1. get_module_logic_tree で現在の記事順と article_id を確認
2. reorder_module_articles に希望順の article_ids を渡す
1. list_my_articles で対象記事の article_id を確認
2. bulk_update_article_status で draft / private / published を一括指定
更新・削除・一括変更は影響範囲が大きいため、対象の ID / slug と現在の本文・構造を確認してから実行します。
update_markdown_article の markdown は全体置換delete_markdown_article と delete_module は confirm: true が必要な破壊的操作delete_module は記事自体を消さず、モジュールと記事の関連だけを削除するtitle を省略し、既存タイトルを維持するget_module_logic_tree で article ID を確認する