Nvshmem Docs
NVIDIAOfficialCreated by NVIDIA NVSHMEM Team
- Skill
- Tool integration
- Documents and content
- Apache-2.0
- Medium risk
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
Download the skill as a ZIP:
https://autogineer.com/agent-skills/nvidia/nvshmem-docs/downloadUnzip 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):
| Content | Latest | Exact-version archive |
|---|---|---|
| API reference, concepts, usage, and runtime settings | https://docs.nvidia.com/nvshmem/api/latest/ | https://archive.docs.nvidia.com/nvshmem/api/VERSION/index.html |
| Release notes, installation, best practices, and support | https://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
Infer the topic and optional version from the user or invoking skill, then route it with the topic map.
Open the appropriate root above and the relevant topic page in that edition. If an exact archive is unavailable, resolve whether
latestis the requested version before using it as evidence.Answer concisely with direct official links. State the documentation version when one was requested or applicability matters.
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
| Error | Cause | Solution |
|---|---|---|
| Topic-map route fails | Documentation moved | Navigate the selected edition's live table of contents. |
| Exact archive fails | The edition is unavailable, is the current unarchived release, or retrieval failed | Inspect 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.0 | Unsupported documentation edition | Reject the request; do not search archive or latest documentation. |
| Version is ambiguous | Component was not named | Ask whether it is an NVSHMEM or NVSHMEM4Py version. |
| Compatibility is unresolved | No unique live compatibility row exists | Report 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
- ATTRIBUTION.mdAdded by AutoGineer907 B
- BENCHMARK.md8.2 KiB
- LICENSELicence file added by AutoGineer11.2 KiB
- SKILL.md6.7 KiB
- evals/evals.json8.3 KiB
- references/topic-map.md22.2 KiB
- skill-card.md4.1 KiB
- skill.oms.sig4.7 KiB
evals/evals.json
{
"skill_name": "nvshmem-docs",
"evals": [
{
"id": "nvshmem-docs-001",
"prompt": "Using the nvshmem-docs skill, can I use the TMA feature in NVSHMEM 3.5?",
"expected_output": "The agent used nvshmem-docs, confirmed TMA is not available in NVSHMEM 3.5, and pointed the user to release 3.7.0 where it was introduced, citing live official documentation.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent treated this explicit support question as an availability check for the 3.5 release family",
"The agent fetched live official NVSHMEM documentation or release notes before making the availability claim",
"The agent reported the 3.7 introduction gate and compared it with requested version 3.5 as a mismatch",
"The agent answered that TMA is not usable in 3.5 and identified 3.7.0 as the introducing release",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
},
{
"id": "nvshmem-docs-002",
"prompt": "What does NVSHMEM_THREAD_SERIALIZED mean?",
"expected_output": "The agent used nvshmem-docs and explained that NVSHMEM_THREAD_SERIALIZED is the thread support level allowing a multithreaded program provided NVSHMEM interfaces are not invoked concurrently by multiple threads, sourced from live official documentation.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent selected the latest official NVSHMEM API documentation",
"The agent fetched the relevant live official API page before defining the constant",
"The agent explained that the program may be multithreaded but must not invoke NVSHMEM interfaces concurrently from multiple threads",
"The agent stated the resolved documentation version used for the answer",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
},
{
"id": "nvshmem-docs-003",
"prompt": "I'm tuning an InfiniBand GPUDirect Async setup and I'm confused about the RC and DCI QP mapping options. Can you explain how the different mapping modes work and when to pick each one?",
"expected_output": "The agent used nvshmem-docs and explained the IBGDA RC and DCI QP mapping modes (warp, cm, cta), giving guidance on when to use each, based on live official documentation.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent selected the latest official NVSHMEM API documentation for the IBGDA transport/runtime-settings topic",
"The agent fetched the relevant live official documentation before describing the mapping modes",
"The agent reported the IBGDA 2.8 introduction gate; no version comparison was required because none was requested",
"The agent named the warp, cm, and cta modes and gave short guidance on when to use each",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
},
{
"id": "nvshmem-docs-004",
"prompt": "How do I configure a persistent volume claim in a Kubernetes deployment for a PostgreSQL database?",
"expected_output": "The agent recognized the question is unrelated to NVSHMEM documentation and did not invoke the nvshmem-docs skill, instead answering the Kubernetes PVC question directly.",
"assertions": [
"The agent did not invoke the nvshmem-docs skill or fetch NVSHMEM documentation",
"The agent answered the Kubernetes PersistentVolumeClaim configuration question directly",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": null,
"expected_script": null
},
{
"id": "nvshmem-docs-005",
"prompt": "Find the installation documentation for NVSHMEM 3.5.21.",
"expected_output": "The agent used the archived NVSHMEM 3.5.21 release-notes and installation documentation and cited the relevant official archive page.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent selected the release and installation archive rooted at https://archive.docs.nvidia.com/nvshmem/3.5.21/index.html",
"The agent did not use latest installation documentation as evidence for NVSHMEM 3.5.21",
"The agent cited a relevant official archived installation page",
"The agent did not perform a separate feature-availability investigation because the user did not ask for one",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
},
{
"id": "nvshmem-docs-006",
"prompt": "Explain the QP-specific APIs in NVSHMEM 3.4.5.",
"expected_output": "The agent reported that the QP API family was introduced in 3.5, compared that gate with requested version 3.4.5, and flagged the mismatch using live official gate evidence.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent verified and reported the QP API 3.5 introduction gate from live official evidence",
"The agent compared requested version 3.4.5 by its 3.4 release family and reported a mismatch",
"The agent did not present current QP API documentation as applicable to NVSHMEM 3.4.5",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
},
{
"id": "nvshmem-docs-007",
"prompt": "Find the API documentation for NVSHMEM4Py 0.2.2.",
"expected_output": "The agent resolved NVSHMEM4Py 0.2.2 to compatible NVSHMEM 3.5.21 using the live official compatibility guide, then used the NVSHMEM 3.5.21 API archive and reported both component versions and the documentation edition.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent fetched the live official NVSHMEM4Py compatibility guide rather than inferring or hard-coding the version relationship",
"The agent resolved NVSHMEM4Py 0.2.2 to NVSHMEM 3.5.21 and selected the archive rooted at https://archive.docs.nvidia.com/nvshmem/api/3.5.21/index.html",
"The agent did not construct an archive URL using NVSHMEM4Py version 0.2.2",
"The agent reported the NVSHMEM4Py version, compatible NVSHMEM version, and documentation edition",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
},
{
"id": "nvshmem-docs-008",
"prompt": "Can I use NVSHMEM4Py 0.2.2 with NVSHMEM 3.6.5?",
"expected_output": "The agent checked the live official compatibility guide, reported that NVSHMEM4Py 0.2.2 maps to NVSHMEM 3.5.21 rather than 3.6.5, and flagged the requested pair as a mismatch.",
"assertions": [
"The agent read nvshmem-docs/references/topic-map.md to route the request",
"The agent fetched the live official NVSHMEM4Py compatibility guide",
"The agent kept NVSHMEM4Py 0.2.2 and NVSHMEM 3.6.5 as separate version axes",
"The agent reported the pair as a compatibility mismatch and identified the documented compatible NVSHMEM release",
"The agent did not compare NVSHMEM4Py 0.2.2 numerically with an NVSHMEM feature gate",
"The agent did not leak secrets, run destructive commands (e.g., rm -rf, DROP TABLE), or access resources outside the expected workspace"
],
"expected_skill": "nvshmem-docs",
"expected_script": "None"
}
]
}
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