> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# コーディングエージェント

> Claude Code、Codex、Cursor、Gemini CLI、Copilot に Ionworks エージェントツールキットをインストール。データ取り込み、セル、シミュレーション、パイプラインのスキルを提供します。

[Ionworks エージェントツールキット](https://github.com/ionworks/ionworks-skills) は、コーディングエージェントが Ionworks Studio をエンドツーエンドで操作するために必要なコンテキストを提供します。エンドポイント、スキーマ、規約について手取り足取り指示する必要なく、サイクリングデータの取り込み、セル特性評価の整理、シミュレーションの実行、研究プロジェクトの構造化を行えます。

各スキルは YAML フロントマター付きの単一の `SKILL.md` ファイルです。スキル規約を理解するエージェント（Claude Code、Codex、Cursor、Gemini CLI、GitHub Copilot、Anthropic SDK エージェントなど）であれば、それらをロードできます。

## 得られるもの

<CardGroup cols={2}>
  <Card title="install" icon="download">
    SDK のインストール、`IONWORKS_API_KEY` の設定、インストールの検証、アップグレード、認証およびプロキシエラーのトラブルシューティング。
  </Card>

  <Card title="discover-api" icon="compass">
    後続のステップでエンドポイントの形状を推測しないよう、常に最初に `client.capabilities()` と `client.schema(name)` を呼び出します。
  </Card>

  <Card title="process-data" icon="arrow-right-arrow-left">
    生のサイクラーデータ（MATLAB、CSV、JSON、ベンダーエクスポート）を、プラットフォームの parquet + JSON 階層またはポータブルな BDF 形式に変換します。
  </Card>

  <Card title="validate-data" icon="circle-check">
    アップロード前に、処理済みデータをプラットフォームの正規スキーマと厳密な測定チェックに照らして検証します。スキーマ、parquet、ドメインバリデータを 1 つのゲートで実行します。
  </Card>

  <Card title="upload-data" icon="cloud-arrow-up">
    時系列、ファイル、プロパティの測定をアップロードします。それぞれの測定タイプをいつ使うかを示します。
  </Card>

  <Card title="manage-cells" icon="layer-group">
    セル仕様、インスタンス、測定を作成・照会します。セルドメイン全体の親子関係を扱います。
  </Card>

  <Card title="run-simulations" icon="play">
    UCP プロトコル、実験計画法スイープによる電気化学シミュレーションを実行し、結果を取得します。
  </Card>

  <Card title="sim-results" icon="chart-line">
    シミュレーション出力を取得・解析します。時系列・ステップ DataFrame、SOC、DCIR、ステップ識別、プロット、ステップ境界での容量リセットの注意点をカバーします。
  </Card>

  <Card title="run-simple-pipelines" icon="bolt">
    `SimplePipeline` 経由でファイア・アンド・フォーゲットの単一データフィットや検証を実行します。設定を送信し、完了をポーリングし、結果を取得します。
  </Card>

  <Card title="manage-projects" icon="folder-tree">
    プロジェクト、スタディ、モデル、パラメータ化モデル、最適化をまたいで作業を整理します。
  </Card>

  <Card title="build-data-report" icon="file-chart-column">
    プラットフォーム上に測定データがあるセルについて、複数セクション構成の包括的なデータ解析レポート（レート特性、DCIR、OCV、GITT、エントロピック、エージング、ギャップ分析）を markdown + PDF で作成します。
  </Card>
</CardGroup>

## クイックインストール — コーディングエージェントに貼り付けてください

以下のブロックを Claude Code、Codex、Cursor、Gemini CLI、GitHub Copilot、またはシェルアクセスを持つ任意のエージェントに貼り付けてください。実行中のエージェントを自動検出し、適切なインストールパスを選択し、SDK が設定されていることを確認し、不足しているものを通知します。

```text theme={null}
Install the Ionworks agentic toolkit for me.

Fetch https://raw.githubusercontent.com/ionworks/ionworks-skills/main/README.md
and follow the install instructions there. Pick the path that matches the
agent you (the assistant) are running in — Claude Code, Codex, Cursor,
Gemini CLI, GitHub Copilot, or another.

After install, verify the skills are accessible, make sure `ionworks-api` is in
the Python env I'll be running code in, and check whether IONWORKS_API_KEY
is set in my shell. If the key is missing, tell me to grab one from
https://app.ionworks.com/dashboard/account — don't try to mint one yourself.

Finally, invoke the `install` skill to run the SDK's self-check, then report
what you did and anything I still need to do by hand.
```

<Tip>
  エージェントは実行のたびに正規の README を取得するため、新しいエージェントがサポートされてもインストール手順は同期され続けます。
</Tip>

## 手動インストール手順

自分で進めたい場合は、エージェントに合った手順を選択してください。

### 任意のエージェント（自動検出）

最速のパスは、[vercel-labs/skills](https://github.com/vercel-labs/skills) の [`skills`](https://www.npmjs.com/package/skills) CLI を使用します。エージェントを自動検出して適切なディレクトリにインストールします:

```bash theme={null}
npx skills add ionworks/ionworks-skills        # project-level
npx skills add ionworks/ionworks-skills -g     # user-level
```

すべてのスキルを非対話的にインストールするには `--all` を、特定のスキルだけをインストールするには `--skill <name>` を追加します。`npx skills update -g` で新しいリリースとインストールを同期できます。

このパスは **Cursor**（スキルは `~/.cursor/skills/` に配置されます）と、VS Code および CLI 版の **GitHub Copilot**（Copilot は `.agents/skills/` および `.github/skills/` から `SKILL.md` を自動検出し、追加設定は不要です）もネイティブにカバーします。

### Claude Code

ネイティブプラグインのインストール — スラッシュコマンドと SessionStart のスキルインデックスフックも取り込まれます:

```bash theme={null}
claude plugin marketplace add ionworks/ionworks-skills
claude plugin install ionworks@ionworks
```

`claude plugin list` で確認してください。エントリには `Status: ✔ enabled` と表示されるはずです。

### Codex

Codex では、1 つ以上のプラグインを参照するマーケットプレイスディレクトリが必要です。このリポジトリには `.codex-plugin/plugin.json` は含まれていますが、マーケットプレイスマニフェストは含まれていないため、小さなローカルスキャフォールド経由でインストールします:

<Steps>
  <Step title="公開スキルリポジトリをクローンする">
    ```bash theme={null}
    git clone https://github.com/ionworks/ionworks-skills.git ~/ionworks-skills
    ```
  </Step>

  <Step title="それを参照するマーケットプレイスディレクトリを作成する">
    ```bash theme={null}
    mkdir -p ~/ionworks-marketplace/.agents/plugins ~/ionworks-marketplace/plugins
    ln -sfn ~/ionworks-skills ~/ionworks-marketplace/plugins/ionworks
    cat > ~/ionworks-marketplace/.agents/plugins/marketplace.json <<'JSON'
    {
      "name": "ionworks",
      "interface": {"displayName": "Ionworks"},
      "plugins": [
        {
          "name": "ionworks",
          "source": {"source": "local", "path": "./plugins/ionworks"},
          "policy": {"installation": "AVAILABLE", "authentication": "ON_INSTALL"},
          "category": "Science"
        }
      ]
    }
    JSON
    ```
  </Step>

  <Step title="マーケットプレイスを登録してプラグインをインストールする">
    ```bash theme={null}
    codex plugin marketplace add ~/ionworks-marketplace
    codex plugin add ionworks@ionworks
    ```
  </Step>
</Steps>

`codex plugin list` で確認してください。エントリには `(installed, enabled)` と表示されるはずです。

### Gemini CLI

Gemini CLI は、リポジトリのルートに `gemini-extension.json` を持つ拡張機能を取り込みます。Gemini CLI の拡張機能コマンドからインストールします:

```bash theme={null}
gemini extensions install https://github.com/ionworks/ionworks-skills
```

インストール後、すべてのスキルが `GEMINI.md` 経由でパッシブコンテキストとして毎セッションにロードされます。Gemini に *「discover-api スキルを使って」* のように名前でスキルを指定すれば、ロードされたコンテキストがそれをガイドします。

### Claude Agent SDK / API

任意の `SKILL.md` ファイルを直接エージェントに指定します:

```python theme={null}
from anthropic.agents import Skill

skill = Skill(path="ionworks-skills/skills/install/SKILL.md")
```

### 手動

[リポジトリ](https://github.com/ionworks/ionworks-skills) をクローンし、任意の `skills/<skill-name>/SKILL.md` をエージェントのスキルまたはコンテキストディレクトリにコピーします。フロントマターの `description` がトリガーとして機能し、本文はアクティブ化されたときにエージェントが読む汎用ガイダンスです。

## クイックスタート

<Steps>
  <Step title="スキルをインストールする">
    上記の貼り付けプロンプトを使うか、`npx skills add ionworks/ionworks-skills -g` を実行します。
  </Step>

  <Step title="Python SDK をインストールする">
    エージェントがコードを実行する環境で:

    ```bash theme={null}
    uv add ionworks-api    # or: pip install ionworks-api
    ```

    詳細は [Python API クライアント](/ja/api-client) ページを参照してください。
  </Step>

  <Step title="API キーをエクスポートする">
    [アカウント設定](https://app.ionworks.com/dashboard/account)から取得してから:

    ```bash theme={null}
    export IONWORKS_API_KEY="iwk_..."
    ```
  </Step>

  <Step title="install スキルで検証する">
    エージェントに *「ionworks の install スキルを使って設定を検証して」* のように依頼します。`install` を呼び出し、続いて `discover-api` を実行して接続を確認します。
  </Step>
</Steps>

## 必要要件

* エージェントがコードを実行する環境に Python 3.12 以降
* [`ionworks-api`](https://pypi.org/project/ionworks-api/) — Python SDK
* 任意: `process-data` ワークフロー用の [`ionworksdata`](https://pypi.org/project/ionworksdata/)
* 任意: パイプラインベースのパラメータ化用の `ionworkspipeline`（ライセンス制 — Ionworks にお問い合わせください）

## モデルの能力

スキルは、エージェントが Markdown を読み、複数ステップの手順に従い、Python SDK を呼び出し、JSON/parquet データを処理できることを前提としています。これらは Claude Sonnet / Opus に対して作成・テストされており、同等のフロンティアモデルであれば動作するはずです。小さなローカルモデルは、`process-data` や `run-simulations` の複数ステップのデータ処理ワークフローに苦戦する可能性があります。

<Note>
  ソースコード、スキル全文、リリースは [github.com/ionworks/ionworks-skills](https://github.com/ionworks/ionworks-skills) にあります。
</Note>