SDK のプラグイン
Agent SDK を通じてカスタムプラグインを読み込み、コマンド、エージェント、スキル、フックで Claude Code を拡張します
プラグインを使用すると、Claude Code をカスタム機能で拡張でき、プロジェクト全体で共有できます。Agent SDK を通じて、ローカルディレクトリからプログラムでプラグインを読み込み、カスタムスラッシュコマンド、エージェント、スキル、フック、MCP サーバーをエージェントセッションに追加できます。
プラグインとは何ですか?
プラグインは Claude Code 拡張機能のパッケージであり、以下を含めることができます:
- Skills: Claude が自律的に使用するモデル呼び出し機能(
/skill-nameで呼び出すこともできます) - Agents: 特定のタスク用の専門的なサブエージェント
- Hooks: ツール使用およびその他のイベントに応答するイベントハンドラー
- MCP servers: Model Context Protocol 経由の外部ツール統合
commands/ ディレクトリはレガシー形式です。新しいプラグインには skills/ を使用してください。Claude Code は後方互換性のために両方の形式をサポートし続けています。
プラグイン構造とプラグインの作成方法に関する完全な情報については、Plugins を参照してください。
プラグインの読み込み
オプション設定でローカルファイルシステムパスを指定してプラグインを読み込みます。type フィールドは "local" である必要があります。これは SDK が受け入れる唯一の値です。マーケットプレイスまたはリモートリポジトリを通じて配布されているプラグインを使用するには、まずダウンロードしてローカルディレクトリパスを指定してください。SDK は複数の場所から複数のプラグインを読み込むことをサポートしています。
import { query } from "@anthropic-ai/claude-agent-sdk";
for await (const message of query({
prompt: "Hello",
options: {
plugins: [
{ type: "local", path: "./my-plugin" },
{ type: "local", path: "/absolute/path/to/another-plugin" }
]
}
})) {
// Plugin commands, agents, and other features are now available
}
import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions
async def main():
async for message in query(
prompt="Hello",
options=ClaudeAgentOptions(
plugins=[
{"type": "local", "path": "./my-plugin"},
{"type": "local", "path": "/absolute/path/to/another-plugin"},
]
),
):
# Plugin commands, agents, and other features are now available
pass
asyncio.run(main())
パス指定
プラグインパスは以下のいずれかです:
- 相対パス: 現在の作業ディレクトリを基準に解決されます(例:
"./plugins/my-plugin") - 絶対パス: 完全なファイルシステムパス(例:
"/home/user/plugins/my-plugin")
パスはプラグインのルートディレクトリ(.claude-plugin/plugin.json を含むディレクトリ)を指す必要があります。
プラグインインストールの確認
プラグインが正常に読み込まれると、システム初期化メッセージに表示されます。プラグインが利用可能であることを確認できます:
import { query } from "@anthropic-ai/claude-agent-sdk";
for await (const message of query({
prompt: "Hello",
options: {
plugins: [{ type: "local", path: "./my-plugin" }]
}
})) {
if (message.type === "system" && message.subtype === "init") {
// Check loaded plugins
console.log("Plugins:", message.plugins);
// Example: [{ name: "my-plugin", path: "./my-plugin" }]
// Check available commands from plugins
console.log("Commands:", message.slash_commands);
// Example: ["/help", "/compact", "my-plugin:custom-command"]
}
}
import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions, SystemMessage
async def main():
async for message in query(
prompt="Hello",
options=ClaudeAgentOptions(
plugins=[{"type": "local", "path": "./my-plugin"}]
),
):
if isinstance(message, SystemMessage) and message.subtype == "init":
# Check loaded plugins
print("Plugins:", message.data.get("plugins"))
# Example: [{"name": "my-plugin", "path": "./my-plugin"}]
# Check available commands from plugins
print("Commands:", message.data.get("slash_commands"))
# Example: ["/help", "/compact", "my-plugin:custom-command"]
asyncio.run(main())
プラグインスキルの使用
プラグインのスキルは競合を避けるためにプラグイン名で自動的に名前空間化されます。スラッシュコマンドとして呼び出される場合、形式は plugin-name:skill-name です。
import { query } from "@anthropic-ai/claude-agent-sdk";
// Load a plugin with a custom /greet skill
for await (const message of query({
prompt: "/my-plugin:greet", // Use plugin skill with namespace
options: {
plugins: [{ type: "local", path: "./my-plugin" }]
}
})) {
// Claude executes the custom greeting skill from the plugin
if (message.type === "assistant") {
console.log(message.message.content);
}
}
import asyncio
from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage, TextBlock
async def main():
# Load a plugin with a custom /greet skill
async for message in query(
prompt="/demo-plugin:greet", # Use plugin skill with namespace
options=ClaudeAgentOptions(
plugins=[{"type": "local", "path": "./plugins/demo-plugin"}]
),
):
# Claude executes the custom greeting skill from the plugin
if isinstance(message, AssistantMessage):
for block in message.content:
if isinstance(block, TextBlock):
print(f"Claude: {block.text}")
asyncio.run(main())
CLI 経由でプラグインをインストールした場合(例:/plugin install my-plugin@marketplace)、SDK でそのインストールパスを指定することで引き続き使用できます。CLI でインストールされたプラグインについては ~/.claude/plugins/ を確認してください。
完全な例
プラグインの読み込みと使用を示す完全な例を以下に示します:
import { query } from "@anthropic-ai/claude-agent-sdk";
import * as path from "path";
async function runWithPlugin() {
const pluginPath = path.join(__dirname, "plugins", "my-plugin");
console.log("Loading plugin from:", pluginPath);
for await (const message of query({
prompt: "What custom commands do you have available?",
options: {
plugins: [{ type: "local", path: pluginPath }],
maxTurns: 3
}
})) {
if (message.type === "system" && message.subtype === "init") {
console.log("Loaded plugins:", message.plugins);
console.log("Available commands:", message.slash_commands);
}
if (message.type === "assistant") {
console.log("Assistant:", message.message.content);
}
}
}
runWithPlugin().catch(console.error);
#!/usr/bin/env python3
"""Example demonstrating how to use plugins with the Agent SDK."""
from pathlib import Path
import anyio
from claude_agent_sdk import (
AssistantMessage,
ClaudeAgentOptions,
SystemMessage,
TextBlock,
query,
)
async def run_with_plugin():
"""Example using a custom plugin."""
plugin_path = Path(__file__).parent / "plugins" / "demo-plugin"
print(f"Loading plugin from: {plugin_path}")
options = ClaudeAgentOptions(
plugins=[{"type": "local", "path": str(plugin_path)}],
max_turns=3,
)
async for message in query(
prompt="What custom commands do you have available?", options=options
):
if isinstance(message, SystemMessage) and message.subtype == "init":
print(f"Loaded plugins: {message.data.get('plugins')}")
print(f"Available commands: {message.data.get('slash_commands')}")
if isinstance(message, AssistantMessage):
for block in message.content:
if isinstance(block, TextBlock):
print(f"Assistant: {block.text}")
if __name__ == "__main__":
anyio.run(run_with_plugin)
プラグイン構造リファレンス
プラグインディレクトリには .claude-plugin/plugin.json マニフェストファイルが含まれている必要があります。オプションで以下を含めることができます:
my-plugin/
├── .claude-plugin/
│ └── plugin.json # Required: plugin manifest
├── skills/ # Agent Skills (invoked autonomously or via /skill-name)
│ └── my-skill/
│ └── SKILL.md
├── commands/ # Legacy: use skills/ instead
│ └── custom-cmd.md
├── agents/ # Custom agents
│ └── specialist.md
├── hooks/ # Event handlers
│ └── hooks.json
└── .mcp.json # MCP server definitions
プラグイン作成の詳細については、以下を参照してください:
- Plugins - プラグイン開発の完全ガイド
- Plugins reference - 技術仕様とスキーマ
一般的なユースケース
開発とテスト
グローバルにインストールせずに開発中にプラグインを読み込みます:
plugins: [{ type: "local", path: "./dev-plugins/my-plugin" }];
プロジェクト固有の拡張機能
チーム全体の一貫性のためにプラグインをプロジェクトリポジトリに含めます:
plugins: [{ type: "local", path: "./project-plugins/team-workflows" }];
複数のプラグインソース
異なる場所からプラグインを組み合わせます:
plugins: [
{ type: "local", path: "./local-plugin" },
{ type: "local", path: "~/.claude/custom-plugins/shared-plugin" }
];
トラブルシューティング
プラグインが読み込まれない
プラグインが初期化メッセージに表示されない場合:
- パスを確認する: パスがプラグインルートディレクトリ(
.claude-plugin/を含む)を指していることを確認してください - plugin.json を検証する: マニフェストファイルが有効な JSON 構文を持っていることを確認してください
- ファイルパーミッションを確認する: プラグインディレクトリが読み取り可能であることを確認してください
スキルが表示されない
プラグインスキルが機能しない場合:
- 名前空間を使用する: プラグインスキルはスラッシュコマンドとして呼び出される場合、
plugin-name:skill-name形式が必要です - 初期化メッセージを確認する: スキルが正しい名前空間で
slash_commandsに表示されることを確認してください - スキルファイルを検証する: 各スキルが
skills/の下の独自のサブディレクトリにSKILL.mdファイルを持っていることを確認してください(例:skills/my-skill/SKILL.md)
パス解決の問題
相対パスが機能しない場合:
- 作業ディレクトリを確認する: 相対パスは現在の作業ディレクトリから解決されます
- 絶対パスを使用する: 信頼性のために、絶対パスの使用を検討してください
- パスを正規化する: パスユーティリティを使用してパスを正しく構築してください
関連項目
- Plugins - プラグイン開発の完全ガイド
- Plugins reference - 技術仕様
- Slash Commands - SDK でのスラッシュコマンドの使用
- Subagents - 専門的なエージェントの操作
- Skills - Agent Skills の使用