Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/lvndry/jazz/llms.txt

Use this file to discover all available pages before exploring further.

Authentication commands let you connect Jazz to external services that require OAuth or API authentication.

​
jazz auth gmail login

Authenticate with Gmail using OAuth2. 
jazz auth gmail login
This command:
  1. Opens your browser to Google’s OAuth consent screen
  2. Prompts you to grant Jazz permission to access Gmail
  3. Stores the OAuth tokens securely in ~/.jazz/credentials/
  4. Enables email-related tools and workflows
Gmail authentication uses OAuth2 with the minimum required scopes for reading and managing emails.

​
jazz auth gmail logout

Revoke Gmail authentication and delete stored tokens. 
jazz auth gmail logout
This will:
  • Delete OAuth tokens from local storage
  • Disable email-related tools
  • Require re-authentication for future email access
After logout, workflows and agents that depend on Gmail will no longer function until you log in again.

​
Supported services

Currently, Jazz supports authentication for:

Gmail

OAuth2 authentication for reading, sending, and managing emailsScopes:
  • gmail.readonly - Read emails
  • gmail.modify - Archive, label, delete emails
  • gmail.send - Send emails

​
Credential storage

Authentication credentials are stored securely:
  • Location: ~/.jazz/credentials/
  • Format: Encrypted JSON files
  • Permissions: Read/write for user only (600)
Never commit the ~/.jazz/credentials/ directory to version control.

​
Examples

​
Authenticate with Gmail

jazz auth gmail login
Expected output: 
🔐 Authenticating with Gmail...

 Opening browser for authentication...
 ✓ Authentication successful!
 ✓ Credentials saved

You can now use Gmail tools:
  • read_email
  • send_email
  • search_emails
  • archive_email
  • delete_emails

​
Check authentication status

After authenticating, check if Gmail tools are available: 
jazz agent chat my-agent
> /tools
You should see Gmail tools listed in the available tools.

​
Revoke authentication

jazz auth gmail logout
Expected output: 
🔓 Logging out of Gmail...
 ✓ Credentials removed
 ✓ Gmail tools disabled

​
Troubleshooting

If the browser doesn’t open automatically:
  1. Copy the URL displayed in the terminal
  2. Paste it into your browser manually
  3. Complete the OAuth flow
  4. Jazz will detect the authentication callback
If you see a permission denied error:
  1. Check that ~/.jazz/credentials/ exists and has correct permissions
  2. Run: chmod 700 ~/.jazz/credentials/
  3. Try authenticating again
If you see “token expired” errors:
  1. Run jazz auth gmail logout
  2. Run jazz auth gmail login to re-authenticate
  3. Jazz will obtain fresh tokens

​
Security considerations

OAuth tokens provide access to your accounts. Treat them like passwords:
  • Never share your ~/.jazz/credentials/ directory
  • Add credentials/ to your .gitignore
  • Use separate Google accounts for testing
  • Revoke access from Google Account settings if compromised
  • Regularly audit which services Jazz has access to

​
Revoking access

You can revoke Jazz’s access from Google’s side:
  1. Visit Google Account Permissions
  2. Find “Jazz” in the list of apps
  3. Click Remove Access
  4. Run jazz auth gmail logout to clean up local tokens

​
Future authentication

Jazz will support authentication for additional services:
  • Calendar (Google Calendar, Outlook)
  • Slack (send messages, read channels)
  • GitHub (via OAuth, in addition to MCP)
  • Linear (issues, projects)
  • Notion (via OAuth, in addition to MCP)

​
Next steps

Email automation

Learn how to automate email workflows

Workflows

Create workflows that use authenticated services

Build docs developers (and LLMs) love

Get started for freeTalk to us