Generated banner for Nvshmem Docs
Generated logo for Nvshmem Docs

Nvshmem Docs

NVIDIAOfficialCreated by NVIDIA NVSHMEM Team

  • Skill
  • Tool integration
  • Documents and content
  • Apache-2.0
  • Medium risk

From the author

Find version-aware official NVSHMEM and NVSHMEM4Py documentation for releases, installation, APIs, runtime settings, transports, containers, and troubleshooting.
— the description by NVIDIA NVSHMEM Team

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured approach to querying official NVIDIA NVSHMEM and NVSHMEM4Py documentation. It uses a version-aware routing system to navigate between the latest documentation and historical archives for versions 3.0 and newer. The skill ensures technical accuracy by requiring live retrieval of official documentation pages rather than relying on internal knowledge, and it includes logic for verifying feature availability gates and compatibility between NVSHMEM and its Python bindings.

What it does

  • Routes user queries to relevant official documentation sections using a topic map.
  • Retrieves documentation for specific NVSHMEM versions via official archive URLs.
  • Checks feature availability against introduced or removed version gates.
  • Resolves compatibility information for NVSHMEM4Py and NVSHMEM version pairs.
  • Provides direct links to official NVIDIA documentation and release notes.
  • Handles version normalization and identifies when requested archives are unavailable.

When to use it

  • When you need to find installation instructions or API references for a specific NVSHMEM version.
  • When verifying if a specific feature was available in a particular release.
  • When checking compatibility requirements between NVSHMEM and NVSHMEM4Py.
  • When troubleshooting runtime settings or transport configurations using official documentation.

Advantages

  • Ensures technical claims are backed by live, official documentation.
  • Supports version-specific lookups to avoid confusion between different release cycles.
  • Provides a consistent method for verifying feature gates and deprecations.
  • Reduces manual search time by routing directly to the most relevant documentation pages.

Usage examples

“Explain NVSHMEM_THREAD_SERIALIZED.”
The agent retrieves the official documentation page for runtime settings and provides a summary of the environment variable's purpose and usage.
“Find NVSHMEM4Py installation documentation for NVSHMEM 3.5.21.”
The agent identifies the correct archive for NVSHMEM 3.5.x and provides the specific installation steps for the Python bindings.
“Check whether NVSHMEM4Py 0.2.2 is compatible with NVSHMEM 3.6.5.”
The agent consults the compatibility guide to verify the version pair and reports the support status.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/nvidia/nvshmem-docs/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip nvshmem-docs.zip -d .agents/skills

Documentation by NVIDIA NVSHMEM Team

NVSHMEM Documentation

Purpose

Find and summarize version-aware official NVSHMEM and NVSHMEM4Py documentation. Fetch and cite the most specific live pages; do not make technical claims from memory, search snippets, or the bundled topic map.

Prerequisites

Require topic-map.md and a retrieval tool that can open public NVIDIA HTTPS documentation. No API key or account is required. Support only NVSHMEM versions whose major version is 3 or later; reject a requested version below 3 before looking up documentation.

Instructions

Read the topic map for every request to resolve the topic and candidate pages. Use it only for routing; it is not evidence.

Choose the documentation edition

Normalize an optional leading v. Use latest when no version is requested. For an exact MAJOR.MINOR.PATCH version, first use its archive. Replace the literal VERSION in each archive URL below with the normalized NVSHMEM version (for example, 3.7.1 becomes https://archive.docs.nvidia.com/nvshmem/api/3.7.1/index.html):

ContentLatestExact-version archive
API reference, concepts, usage, and runtime settingshttps://docs.nvidia.com/nvshmem/api/latest/https://archive.docs.nvidia.com/nvshmem/api/VERSION/index.html
Release notes, installation, best practices, and supporthttps://docs.nvidia.com/nvshmem/release-notes-install-guide/https://archive.docs.nvidia.com/nvshmem/VERSION/index.html

For a MAJOR.MINOR value, ask for the patch only when an exact archived edition is necessary. Start at the selected root and follow its table of contents because internal paths can differ between editions. For cross-cutting questions, use both documentation sets from the same edition.

When an exact archive is unavailable, inspect the relevant latest root and its official release/version information. If it identifies the requested version as the current release, use that latest documentation and state that the requested version is served from latest rather than an archive. If latest identifies a different version, report that the requested archive is unavailable; offer the different latest documentation only as clearly labeled current context. Never silently use latest documentation for another version.

Retrieve and answer
  1. Infer the topic and optional version from the user or invoking skill, then route it with the topic map.

  2. Open the appropriate root above and the relevant topic page in that edition. If an exact archive is unavailable, resolve whether latest is the requested version before using it as evidence.

  3. Answer concisely with direct official links. State the documentation version when one was requested or applicability matters.

  4. If an exact archive cannot be retrieved and latest is a different version, say so. Offer clearly labeled latest context only if useful.

Keep answers user-facing. Do not disclose internal retrieval mechanics or attempted-source details; report only conclusions, applicable versions, evidence links, and material uncertainty.

If live pages cannot be retrieved, return the appropriate root links, state that their contents were not verified, and avoid documentation-backed technical claims.

Handle NVSHMEM4Py

For an NVSHMEM4Py request with no version, use the latest documentation. If an NVSHMEM version is requested, use that NVSHMEM documentation edition without resolving the NVSHMEM4Py package version. Only when an NVSHMEM4Py version or version compatibility is requested, resolve the independent version pair from the live compatibility guide—never infer or hard-code it—and use the resolved NVSHMEM version to select an archive. Ask only when a bare version is ambiguous or multiple NVSHMEM releases match.

Unprefixed topic-map gates apply to NVSHMEM. Prefix a Python-only gate with nvshmem4py:, compare it only with the NVSHMEM4Py version, and name the version axis in the answer.

Check version gates

When a routed topic-map row has introduced_in or removed_in, verify the gate from its live official evidence and always report it. Compare NVSHMEM gates by MAJOR.MINOR and nvshmem4py: gates by the full package version. Report a mismatch when the requested version is before introduced_in or at/after removed_in; otherwise report no mismatch. Use a compact form such as Version gate: introduced in 3.7; requested 3.5 — mismatch.

Do not perform a broader availability search merely because a version was supplied. Only do so when the user explicitly asks whether an ungated feature or exact symbol is available, introduced, removed, or supported. Then inspect the requested archive and matching release notes. Absence from a page or search result is inconclusive; if evidence is not decisive, say availability could not be established.

For NVIDIA HPC SDK containers, use the official NGC catalog and HPC SDK documentation for container procedures. Do not infer the bundled NVSHMEM version from an image tag unless an official page states it.

Limitations

  • Documentation does not prove installed binaries, container contents, configuration, runtime behavior, or performance.

  • A missing page, symbol, or search result does not prove unavailability.

  • Technical answers require retrieved live official evidence; the topic map is only a routing index.

Troubleshooting

ErrorCauseSolution
Topic-map route failsDocumentation movedNavigate the selected edition's live table of contents.
Exact archive failsThe edition is unavailable, is the current unarchived release, or retrieval failedInspect latest to identify its version. Use it only when it matches the request; otherwise report the failure and offer it only as clearly labeled current context.
Requested NVSHMEM version is below 3.0Unsupported documentation editionReject the request; do not search archive or latest documentation.
Version is ambiguousComponent was not namedAsk whether it is an NVSHMEM or NVSHMEM4Py version.
Compatibility is unresolvedNo unique live compatibility row existsReport the candidates or uncertainty; do not infer a pair.

Examples

Use $nvshmem-docs to explain NVSHMEM_THREAD_SERIALIZED.
Use $nvshmem-docs to find NVSHMEM4Py installation documentation for NVSHMEM 3.5.21.
Use $nvshmem-docs to check whether NVSHMEM4Py 0.2.2 is compatible with NVSHMEM 3.6.5.

<!-- ci trigger -->

Files

LICENSE

Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.


                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs an API key

Security

What our scanner noticed· Medium risk

  • Large base64-encoded blobs

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
NVIDIA NVSHMEM Team
Publisher
NVIDIA (Official)
Source
NVIDIA/skills · skills/nvshmem-docs · commit fce3cca
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE-APACHE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by NVIDIA NVSHMEM Team or NVIDIA.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download nvshmem-docs.zip