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

# auth_status

> 現在の認証ステータスと権限を確認します

## 概要

`auth_status` は、認証方式、ユーザー識別情報、付与されているスコープなど、現在の認証状態に関する情報を返します。このツールはパラメータも特定のスコープも必要としません。

**主なユースケース:**

* 認証が正しく構成されているかを確認する
* 他のツールが認可エラーを返した際に権限の問題をデバッグする
* ツールを呼び出す前に、利用可能なスコープを確認する

**主な特長:**

* パラメータ不要
* スコープ不要
* 完全な認証コンテキストを返す

***

## パラメータ

このツールはパラメータを取りません。

### リクエスト例

```json theme={"system"}
{}
```

***

## レスポンス形式

### 成功レスポンス

```json theme={"system"}
{
  "authenticated": true,
  "authMethod": "api_key",
  "userId": 12345,
  "workspaceGuid": null,
  "clientId": "client_001",
  "scopes": [
    "mcp:notes:read",
    "mcp:folders:read"
  ]
}
```

**フィールドの説明:**

| Field           | Type           | Description                                   |
| --------------- | -------------- | --------------------------------------------- |
| `authenticated` | boolean        | このツールが正常に返った場合は常に `true`                      |
| `authMethod`    | string         | 使用された認証方式: `jwt` または `api_key`                |
| `userId`        | number \| null | 認証されたユーザーの ID（user-scoped key の場合に設定されます）     |
| `workspaceGuid` | string \| null | ワークスペース GUID（workspace-scoped key の場合に設定されます） |
| `clientId`      | string         | クライアントアプリケーションの ID                            |
| `scopes`        | string\[]      | 付与されている権限スコープの一覧                              |

***

## スコープについて

`scopes` 配列は、どのツールを使用する権限があるかを示します。

| Scope              | Grants Access To                                                                                                                      |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| `mcp:notes:read`   | `list_notes`, `search_notes`, `get_note`, `get_note_transcript`, `list_document_templates`, `get_document_template`, `get_share_link` |
| `mcp:folders:read` | `search_private_folders`, `search_team_folders`                                                                                       |

***

## 使用例

### 権限エラーのデバッグ

ツール呼び出しが `403 Forbidden` エラーを返した場合は、`auth_status` を使ってスコープを確認します。

```json theme={"system"}
// 1. Call auth_status
{}

// 2. Check the response
{
  "authenticated": true,
  "authMethod": "api_key",
  "userId": 12345,
  "workspaceGuid": null,
  "clientId": "client_001",
  "scopes": ["mcp:notes:read"]
}
```

この例では、key には `mcp:notes:read` スコープしかありません。別のスコープを必要とするツール（たとえばフォルダ検索の `mcp:folders:read`）は `403 Forbidden` を返します。

### API key の種類を確認する

`userId` と `workspaceGuid` を確認することで、どの種類の API key を使用しているかを判別できます。

* **User-scoped key:** `userId` が設定され、`workspaceGuid` が `null`。複数のワークスペースにまたがってアクセスできます。
* **Workspace-scoped key:** `workspaceGuid` が設定され、`userId` が `null`。単一のワークスペースに紐づき、ユーザー識別情報を持ちません。

***

## よくあるエラー

### 無効または期限切れの認証情報

<Error>
  ```json theme={"system"}
  {
    "error": "Authentication failed. Invalid or expired credentials.",
    "code": "UNAUTHORIZED",
    "statusCode": 401
  }
  ```
</Error>

**解決方法:** API key または JWT token が正しく、期限切れになっていないことを確認してください。必要に応じて新しいキーを生成してください。

***

## ベストプラクティス

<AccordionGroup>
  <Accordion title="Call auth_status on Startup">
    MCP クライアントを初期化する際は、まず `auth_status` を呼び出して接続を確認し、利用可能なスコープを検証してください。これにより、他のツールを呼び出す前に構成の問題を早期に発見できます。
  </Accordion>

  <Accordion title="Use for Troubleshooting">
    ツールが予期しない認可エラーを返した場合、`auth_status` は問題を診断する最も速い手段です。必要なスコープが `scopes` 配列に含まれているかをご確認ください。
  </Accordion>
</AccordionGroup>