AIを活用してApiaryのAPI設計図を更新する方法

エージェントが現在のAPI仕様を取得し、指示に基づいて内容を編集した後、更新版を再公開します。これにより、ドキュメントとコードの同期が保たれます。エージェントによる具体的なデータ処理の流れは以下の通りです。

1. 01

   仕様の取得

   エージェントが対象となるAPI設計図を検索し、現在の状態を確認します。

   get_api
2. 02

   変更の適用

   新しいエンドポイント、パラメータ、または説明文を追加するために、仕様書を書き換えます。

   get_api
3. 03

   更新の反映

   編集した設計図をApiaryサービスに送信します。

   publish_blueprint
4. 04

   ステータスの確認

   更新が正常に完了したかを確認し、ドキュメントが公開されたことを通知します。

   publish_blueprint

Apiary Connector

準備完了です。MCPクライアントを選択し、セットアップ手順に従ってください。

コネクタリンクhttps://edge.vinkius.com/vk_preview_UAsHBD3gjamXcRpVpwIeIHmn77OKcfcfMA4F8oBO/mcpコピー

Claude Desktop

以下の手順で数秒で接続できます。

1. 1In Claude Desktop, open Settings → Connectors.
2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
3. 3Click Add and start a new chat — Apiary capabilities are ready to use.

設定 · claude_desktop_config.jsonコピー

{
  "mcpServers": {
    "apiary-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_UAsHBD3gjamXcRpVpwIeIHmn77OKcfcfMA4F8oBO/mcp"
    }
  }
}

• Claude
• ChatGPT
• Cursor
• VS Code
• Windsurf
• Claude Code
• JetBrains
• Cline

Vinkiusのインターフェース経由でApiaryにログインし、接続を確立します。認証情報は暗号化されて保持され、エージェントは即座に設計図へアクセスできるようになります。

• 01

  AIがAPIプロジェクト全体を削除してしまうことはありますか？

  いいえ。エージェントには設計図の取得と公開を行うツールのみが与えられており、プロジェクトを削除する権限はありません。

• 02

  AIは変更を自動的に公開しますか？

  いいえ。変更を行った後、更新された設計図を公開するかどうかは、ユーザーが明示的に指示する必要があります。

• 03

  これを使って、全く新しいAPIをゼロから作成できますか？

  エージェントが内容のドラフトを作成することは可能ですが、更新や公開のプロセスは既存の設計図をベースに行われます。

• 04

  AIがAPIの実装コードを書き換えることはありますか？

  いいえ。このコネクターはApiary内のドキュメントを操作するものであり、実際のソースコードには干渉しません。

• 05

  どのAPIを更新すべきか、エージェントはどうやって判断しますか？

  プロンプトの中でAPIの名前またはIDを指定してください。エージェントはその情報をもとに適切な仕様書を見つけ出します。

• Apiaryについてさらに詳しく知りたいですか？ Apiary Connectorの全機能を見る