Skip to main content
Glama
snyk

Snyk API & Web MCP Server

Official
by snyk

probely_configure_logout_detection

Automates logout detection setup for web scans, enabling the scanner to identify when re-authentication is needed by configuring session check URLs and logout detectors, with auto-detection from the login sequence.

Instructions

Configure logout detection for a target. This helps the scanner detect when it needs to re-authenticate.

The Probely API requires BOTH check_session_url AND at least one logout detector to be defined before logout detection can be enabled. This function handles the proper ordering automatically.

When no detector is specified, the tool automatically extracts a CSS selector from the target's login sequence (typically the username field) and uses it as the logout detector. This is the most reliable approach: if the login form elements appear on the page, the user is logged out.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetIdYesThe target ID
enabledNoWhether to enable logout detection (default: True)
check_session_urlNoURL to check if session is still valid. Should return 200 when logged in, and 401/403 when logged out. Common examples: /api/me, /api/user, /api/session
logout_detector_typeNoType of logout detector to create if none exist. Options: 'sel' (CSS selector - recommended), 'text' (text after logout), 'url' (redirect URL). If not provided, auto-extracts CSS selector from login sequence, or falls back to 'text: Login'.
logout_detector_valueNoValue for the logout detector. Required if logout_detector_type is provided.
logout_conditionNoWhen to consider the target logged out based on detectors. 'any' (default) = logged out if ANY detector matches (OR logic). 'all' = logged out only if ALL detectors match (AND logic). Use 'all' when some detector patterns also appear on the logged-in page.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

No annotations provided, so the description carries full burden. It discloses automatic extraction of CSS selector from login sequence when no detector is provided, and the requirement for both parameters. Lacks details on idempotency or overwriting behavior.

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?

The description is mostly concise, but the requirement for both check_session_url and a detector is mentioned twice. Could be slightly more streamlined, but overall it's well-structured and front-loaded.

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

Completeness5/5

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

With 6 parameters, full schema coverage, and an output schema, the description covers all key behavioral aspects: purpose, prerequisites, automatic behavior, and condition logic. It is complete for an AI agent to invoke correctly.

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

Parameters5/5

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

Schema coverage is 100%, but the description adds substantial meaning: explains automatic fallback for logout_detector_type, clarifies the 'any' vs 'all' condition, and emphasizes the requirement for both check_session_url and a detector, which goes beyond schema parameter descriptions.

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 the tool configures logout detection for a target to help the scanner re-authenticate. It distinguishes from sibling tools like probely_create_logout_detector by describing its higher-level configuration role, including automatic detector extraction.

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 prerequisites (both check_session_url and a detector needed) and when to use 'any' vs 'all' condition. However, it does not explicitly state when not to use this tool or direct users to alternatives like probely_create_logout_detector for manual detector creation.

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/snyk/saw-mcp'

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