Skip to main content

​
Overview

auth_status returns the authentication method, the user, and the granted scopes. It takes no parameters and needs no particular scope. When to use
  • Verify that authentication is configured correctly
  • Debug permission issues when other tools return authorization errors
  • Confirm which scopes are available before making tool calls
Key Features:
  • No parameters required
  • No scope required
  • Returns complete authentication context

​
Parameters

This tool takes no parameters.

​
Request Example

​
Response Format

​
Success Response

Field Descriptions:

​
Understanding Scopes

The scopes array indicates which tools you have permission to use: get_note_folders requires both mcp:note:read and mcp:folder:read (folders are looked up relative to a specific note). Existing tokens and keys issued with the older notation (mcp:notes:read, mcp:folders:read) still work.

​
Usage Examples

​
Debugging Permission Errors

If a tool call returns a 403 Forbidden error, use auth_status to check your scopes:
In this example, the key only has mcp:note:read scope. Tools requiring a different scope (e.g., mcp:folder:read for folder search) would return 403 Forbidden.

​
Verifying API Key Kind

Check userId and workspaceGuid to determine which kind of API key you are using:
  • User-scoped key: userId is set; workspaceGuid is null. Can span multiple workspaces.
  • Workspace-scoped key: workspaceGuid is set; userId is null. Tied to a single workspace, with no user identity.

​
Common Errors

​
Invalid or Expired Credentials

Solution: Verify your API key or JWT token is correct and has not expired. Generate a new key if needed.

​
Best Practices

When initializing your MCP client, call auth_status first to confirm connectivity and verify available scopes. This catches configuration issues early before making other tool calls.
When a tool returns an unexpected authorization error, auth_status is the fastest way to diagnose the issue. Check whether the required scope is in the scopes array.