- Sonatype Help
- Sonatype Guide
- User Interface Overview
User Interface Overview
Sonatype Guide provides a clean, role-aware interface for exploring component intelligence, vulnerability data, and security policy. This page describes the key areas of the interface and how to navigate them.
Top Navigation Bar
The top navigation bar runs across the full width of the interface and provides access to global search and your account.
Search Bar
The Top Navigation Bar spans the full width of the application and provides quick access to global search functionality and account management options.
Search Components — Enter a package or component name to locate detailed information about software components, such as Available versions, Security and vulnerability data, Dependency information and Component health and policy details
CVE search — You can also search directly using a CVE ID to view vulnerability-specific details, such as Severity and CVSS scores, Affected components and versions, Available remediation guidance and Associated security intelligence
Search results appear dynamically as you type, allowing you to quickly navigate directly to the relevant component or vulnerability page.
Left Navigation Panel
The Left Navigation Panel provides access to the primary sections and features within Sonatype Guide. It serves as the main navigation area for exploring security insights, component intelligence, integrations, and platform resources.
Home - Provides an overview of Sonatype Guide and serves as the starting point for navigating the platform. It may include featured content, quick links, or recently accessed resources.
Components - Allows you to explore open source and third-party software components used within your applications. In this section, you can search for component details, review available versions, examine security and health information, and analyze dependency and package metadata to better understand component risk and usage.
Vulnerabilities - Provides detailed information about known security vulnerabilities affecting software components. Use this section to search for vulnerabilities by CVE ID, review severity and CVSS scores, identify affected components and versions, and access remediation or mitigation guidance.
Security Events - Provides a curated feed of important open-source security events, including high-severity vulnerabilities, malware campaigns, and other events identified by Sonatype Security Research. Use filters or search to find events by component name or CVE ID, then select an event to review its details, remediation guidance, linked CVEs, and impacted components.
Policy - contains policy and compliance-related information that helps organizations enforce security, licensing, and operational standards. Use this section to understand policy evaluation rules, review policy violations, and learn how policies impact component usage and governance.
Agent P - Provides access to Sonatype Guide Agent P, which helps teams keep open-source dependencies up to date. Use this section to connect repositories, configure dependency upgrade settings and validation commands, and review the pull requests created for proposed updates.
MCP - Provides configuration guides and setup instructions for integrating Sonatype MCP with supported AI assistants, IDEs, and developer tools. Use this section to generate API tokens, configure MCP connections, and access ready-to-use integration examples for supported platforms.
API - Provides developer-focused documentation for Sonatype Guide APIs. Use this section to explore available endpoints, understand authentication requirements, review request and response examples, and integrate Sonatype Guide capabilities into external applications and workflows.
Build Tools - contains integration guidance for supported development and CI/CD tools. Use this section to configure scanning, policy evaluation, and automation within build environments such as Maven, Gradle, npm, and other supported tooling.
SCA Platforms - Provides information about supported Software Composition Analysis platforms and ecosystem integrations.
Profile Menu
Your profile avatar is located in the upper-right corner of the navigation bar. The Profile Menu provides access to account and organization-related options. The available menu items depend on your account type and organization role.
Profile - View and update your personal account information, including the display name and email address associated with your Sonatype Guide account.
User Tokens - Generate and manage API tokens used to authenticate requests to the Sonatype Guide API and MCP server.
Organization - Access organization-level settings and configuration options. This menu item is available only to users who belong to an organization.
People - Manage organization members, invite new users, and update roles and permissions. This option is available to organization owners.
Usage - Monitor API consumption and usage metrics for your account or organization, including usage against current plan limits.
Billing - Monitor API consumption and usage metrics for your account or organization, including usage against current plan limits.
Free users can review available plans and upgrade subscriptions.
Organization owners can manage subscriptions, invoices, and payment details.
Organization members do not have access to billing settings.
Sign Out - Securely end your current session and sign out of Sonatype Guide.
Availability by Role
The options displayed in the profile menu vary depending on your account type and organization role.
Menu Option | Free User | Organization Owner | Organization Member |
|---|---|---|---|
Profile | |||
User Tokens | |||
Organization | |||
People | |||
Usage | |||
Billing | |||
Sign Out |