Skip to main content
Glama

scan_zendesk

Scans Zendesk tickets and comments to detect leaked secrets such as API keys, tokens, and passwords. Returns redacted findings without modifying any data.

Instructions

Read Zendesk tickets and comments to detect leaked secrets (API keys, tokens, passwords). Never modifies Zendesk — no tickets or comments are written. Auth: requires ZENDESK_TOKEN, ZENDESK_EMAIL, and ZENDESK_SERVER env vars, or pass server/email/api_key directly. Side effects: a redacted scan report is uploaded to the n0s1 backend; set allow_secret_upload=True to also upload AES-encrypted secret values for AI validation. Returns redacted findings — raw secret values are never included in the output. Subject to Zendesk API rate limits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
serverYesZendesk subdomain e.g. mycompany.zendesk.com (or set ZENDESK_SERVER env var)
emailYesZendesk agent email (or set ZENDESK_EMAIL env var)
api_keyYesZendesk API token (or set ZENDESK_TOKEN env var)
report_formatNoOutput report formatn0s1
show_matched_secret_on_logsNoInclude redacted secret snippets in logs (default: false)
ai_analysisNoQueue async AI credential validation after the scan (requires n0s1 Pro)
n0s1_api_keyNon0s1 API key; overrides the N0S1_TOKEN env var
allow_secret_uploadNoUpload AES-encrypted secret values to the n0s1 backend for AI validation (default: false)
report_uuidNoUUID to assign to the scan report; overrides the auto-generated one

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
report_uuidYes
statusYes
summaryYes
findingsNo
next_cursorNo
usageYes
ai_analysis_statusNo
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate non-destructive but not read-only. The description adds critical context: side effects (uploading scan reports, optional encrypted secret upload), auth requirements, and rate limits. This goes beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Six sentences front-load the core purpose and non-modification. While informative, some details (auth, side effects) are mixed; room for minor tightening but overall efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (9 parameters, required 3, output schema present), the description covers purpose, behavior, auth, side effects, and rate limits. Return format is handled by output schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with good descriptions. The description adds value by explaining env var alternatives and the behavior of allow_secret_upload for AI validation, enhancing parameter understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'Read Zendesk tickets and comments to detect leaked secrets', specifying a specific verb and resource. It distinguishes itself from sibling tools like scan_github and scan_jira by focusing on Zendesk.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains it never modifies Zendesk and lists required auth credentials. While it doesn't explicitly state when not to use, the sibling list implies platform-specific targeting. Provides clear context for use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/spark1security/n0s1-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server