Hyperspell MCP

🚀 クイックスタート

このドキュメントは、Hyperspell の設定と使用方法に関するガイドです。Hyperspell を使用するための必要な設定や、Claude Desktop での注意事項、inspector の使用方法を説明します。

✨ 主な機能

• Hyperspell の設定に必要なトークンやリソースの使用方法を指定できます。
• Claude Desktop での使用時に必要な設定を提供します。
• inspector を使用して Hyperspell を開発モードで実行できます。

📦 インストール

このセクションでは、具体的なインストール手順が記載されていないため、省略します。

💻 使用例

基本的な使用法

設定ガイド

• HYPERSPELL_TOKEN は、有効なユーザーまたはアプリケーションのトークンである必要があります（Hyperspell ドキュメント を参照して、ユーザートークンの取得方法を確認してください）。
• 一部の MCP クライアント（特に Claude Desktop）は、リソース機能をサポートしていません。そのため、すべての内容をツールとして公開することができます。HYPERSPELL_USE_RESOURCES を false（デフォルト値）に設定すると、すべての内容がツールとして公開され、true に設定すると、単一のドキュメントを取得したり、コレクションをリストすることができます。また、both に設定すると、両方の方法をサポートします。
• オプションの設定：HYPERSPELL_COLLECTION を、クエリとデータの追加を行う対象のコレクション名に設定します。設定されていない場合、ユーザーのデフォルトのコレクションが使用されます。

Claude Desktop 注意事項

Claude は uv への絶対パスが必要です。which uv コマンドで見つけることができます（通常は ~/.local/bin/uv にあります）。

{
  "mcpServers": {
    "Hyperspell": {
      "command": "/path/to/uv",
      "args": [
        "run",
        "--with",
        "hyperspell",
        "--with",
        "mcp[cli]",
        "mcp",
        "run",
        "/path/to/hyperspell_mcp/server.py"
      ],
      "env": {
        "HYPERSPELL_TOKEN": "<アプリまたはユーザートークン>",
        "USE_RESOURCES": "false"
      }
    }
  }
}

使用 inspector

.env ファイルを作成し、以下の内容を記述します。

HYPERSPELL_TOKEN=...
HYPERSPELL_USE_RESOURCES=true

その後、以下のコマンドを実行して inspector を起動します。

uv run mcp dev src/hyperspell_mcp/server.py

📚 ドキュメント

設定ガイドの詳細

• HYPERSPELL_TOKEN: Hyperspell の使用に必要なトークンです。このトークンは、ユーザーまたはアプリケーションを識別するために使用されます。Hyperspell ドキュメント を参照して、トークンの取得方法を確認してください。
• HYPERSPELL_USE_RESOURCES: リソース機能の使用方法を指定します。false の場合、すべての内容がツールとして公開されます。true の場合、単一のドキュメントを取得したり、コレクションをリストすることができます。both の場合、両方の方法をサポートします。
• HYPERSPELL_COLLECTION: クエリとデータの追加を行う対象のコレクション名を指定します。設定されていない場合、ユーザーのデフォルトのコレクションが使用されます。

Claude Desktop の注意事項

Claude Desktop では、uv への絶対パスが必要です。which uv コマンドを使用して、uv のパスを見つけることができます。通常は ~/.local/bin/uv にあります。

inspector の使用方法

.env ファイルに必要な設定を記述し、uv run mcp dev src/hyperspell_mcp/server.py コマンドを実行することで、inspector を起動することができます。

🔧 技術詳細

このセクションでは、具体的な技術的な詳細が記載されていないため、省略します。

📄 ライセンス

このセクションでは、ライセンス情報が記載されていないため、省略します。