Skip to content

Conversation

@dagardner-nv
Copy link
Contributor

@dagardner-nv dagardner-nv commented Oct 10, 2025

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Clarified Model Context Protocol (MCP) Authentication docs with renamed titles, standardized terminology, and grammar improvements.
    • Expanded token storage guidance: clearer backend options (in-memory default, S3, MySQL, Redis, custom), encryption notes, persistence behavior, multi-user isolation, plus a new note on in-memory use for dev/testing.
    • Simplified headings and steps for initial auth, token retrieval/refresh, UI launch, and multi-user mode.
    • Improved security and troubleshooting wording.
    • Polished MCP client guide for readability and consistency.

Signed-off-by: Linette Tang <[email protected]>
@dagardner-nv dagardner-nv self-assigned this Oct 10, 2025
@dagardner-nv dagardner-nv added the doc Improvements or additions to documentation label Oct 10, 2025
@dagardner-nv dagardner-nv requested a review from a team as a code owner October 10, 2025 18:02
@dagardner-nv dagardner-nv added the non-breaking Non-breaking change label Oct 10, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 10, 2025

Walkthrough

Documentation across MCP authentication and client guides was edited for clarity, consistency, and terminology. A new abstract interface TokenStorageBase was introduced for token storage with async methods to store, retrieve, delete, and clear tokens. The token storage doc adds configuration guidance and revised backend descriptions.

Changes

Cohort / File(s) Summary
MCP auth docs updates
docs/source/workflows/mcp/mcp-auth.md, docs/source/workflows/mcp/mcp-auth-token-storage.md
Renamed titles to “Model Context Protocol (MCP) …”, standardized wording and headings, clarified multi-user/UI steps, added configuration note about in-memory storage, revised token storage bullets (encryption, backends, persistence, multi-user), and simplified section titles without altering procedures.
MCP client docs edits
docs/source/workflows/mcp/mcp-client.md
Grammar and style refinements, standardized terminology (e.g., “an MCP host”), clarified examples and headings; no functional or API changes.
Token storage interface
nat.plugins.mcp.auth.token_storage
Added abstract class TokenStorageBase with async methods: store(user_id, auth_result), retrieve(user_id), delete(user_id), clear_all().

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Client as MCP Client
  participant Auth as Auth Provider
  participant Store as Token Storage

  rect rgb(230,245,255)
    note over User,Client: Initial authentication
    User->>Client: Initiate sign-in
    Client->>Auth: Request auth
    Auth-->>Client: AuthResult (access/refresh)
    Client->>Store: store(user_id, AuthResult)
    Store-->>Client: OK
  end

  rect rgb(235,255,235)
    note over Client,Store: Using token
    Client->>Store: retrieve(user_id)
    Store-->>Client: AuthResult or None
    alt token found
      Client->>Auth: Use access token for API call
      Auth-->>Client: Response
    else no token
      Client->>Auth: Re-authenticate
      Auth-->>Client: New AuthResult
      Client->>Store: store(user_id, AuthResult)
    end
  end

  rect rgb(255,245,230)
    note over Client,Auth: Refresh flow (on expiry)
    Client->>Auth: Refresh with refresh_token
    Auth-->>Client: New AuthResult
    Client->>Store: store(user_id, AuthResult)
  end

  rect rgb(255,235,235)
    note over Client,Store: Sign-out / cleanup
    Client->>Store: delete(user_id) or clear_all()
    Store-->>Client: OK
  end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly and concisely summarizes the main purpose of the changeset using the imperative mood, stays well within the recommended length, and accurately reflects the updates to MCP documentation for consistency and clarity.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a51173 and bee77f7.

📒 Files selected for processing (3)
  • docs/source/workflows/mcp/mcp-auth-token-storage.md (5 hunks)
  • docs/source/workflows/mcp/mcp-auth.md (5 hunks)
  • docs/source/workflows/mcp/mcp-client.md (11 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/source/**/*.md

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

docs/source/**/*.md: Use the official naming throughout documentation: first use “NVIDIA NeMo Agent toolkit”, subsequent “NeMo Agent toolkit”; never use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq)
Documentation sources are Markdown files under docs/source; images belong in docs/source/_static
Keep docs in sync with code; documentation pipeline must pass Sphinx and link checks; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling correctness
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted terms in accept.txt are allowed

Files:

  • docs/source/workflows/mcp/mcp-client.md
  • docs/source/workflows/mcp/mcp-auth.md
  • docs/source/workflows/mcp/mcp-auth-token-storage.md
**/*

⚙️ CodeRabbit configuration file

**/*: # Code Review Instructions

  • Ensure the code follows best practices and coding standards. - For Python code, follow
    PEP 20 and
    PEP 8 for style guidelines.
  • Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
    Example:
    def my_function(param1: int, param2: str) -> bool:
        pass
  • For Python exception handling, ensure proper stack trace preservation:
    • When re-raising exceptions: use bare raise statements to maintain the original stack trace,
      and use logger.error() (not logger.exception()) to avoid duplicate stack trace output.
    • When catching and logging exceptions without re-raising: always use logger.exception()
      to capture the full stack trace information.

Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any

words listed in the ci/vale/styles/config/vocabularies/nat/reject.txt file, words that might appear to be
spelling mistakes but are listed in the ci/vale/styles/config/vocabularies/nat/accept.txt file are OK.

Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,

and should contain an Apache License 2.0 header comment at the top of each file.

  • Confirm that copyright years are up-to date whenever a file is changed.

Files:

  • docs/source/workflows/mcp/mcp-client.md
  • docs/source/workflows/mcp/mcp-auth.md
  • docs/source/workflows/mcp/mcp-auth-token-storage.md
docs/source/**/*

⚙️ CodeRabbit configuration file

This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the docs/source/_static directory.

Files:

  • docs/source/workflows/mcp/mcp-client.md
  • docs/source/workflows/mcp/mcp-auth.md
  • docs/source/workflows/mcp/mcp-auth-token-storage.md
🪛 markdownlint-cli2 (0.18.1)
docs/source/workflows/mcp/mcp-client.md

20-20: Link text should be descriptive

(MD059, descriptive-link-text)

@AnuradhaKaruppiah
Copy link
Contributor

/merge

@rapids-bot rapids-bot bot merged commit d92b863 into NVIDIA:release/1.3 Oct 10, 2025
17 checks passed
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Oct 10, 2025
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

* **Documentation**
  * Clarified Model Context Protocol (MCP) Authentication docs with renamed titles, standardized terminology, and grammar improvements.
  * Expanded token storage guidance: clearer backend options (in-memory default, S3, MySQL, Redis, custom), encryption notes, persistence behavior, multi-user isolation, plus a new note on in-memory use for dev/testing.
  * Simplified headings and steps for initial auth, token retrieval/refresh, UI launch, and multi-user mode.
  * Improved security and troubleshooting wording.
  * Polished MCP client guide for readability and consistency.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#977
Signed-off-by: Yuchen Zhang <[email protected]>
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Oct 10, 2025
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

* **Documentation**
  * Clarified Model Context Protocol (MCP) Authentication docs with renamed titles, standardized terminology, and grammar improvements.
  * Expanded token storage guidance: clearer backend options (in-memory default, S3, MySQL, Redis, custom), encryption notes, persistence behavior, multi-user isolation, plus a new note on in-memory use for dev/testing.
  * Simplified headings and steps for initial auth, token retrieval/refresh, UI launch, and multi-user mode.
  * Improved security and troubleshooting wording.
  * Polished MCP client guide for readability and consistency.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#977

Signed-off-by: Yuchen Zhang <[email protected]>
yczhang-nv pushed a commit to yczhang-nv/NeMo-Agent-Toolkit that referenced this pull request Oct 10, 2025
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

* **Documentation**
  * Clarified Model Context Protocol (MCP) Authentication docs with renamed titles, standardized terminology, and grammar improvements.
  * Expanded token storage guidance: clearer backend options (in-memory default, S3, MySQL, Redis, custom), encryption notes, persistence behavior, multi-user isolation, plus a new note on in-memory use for dev/testing.
  * Simplified headings and steps for initial auth, token retrieval/refresh, UI launch, and multi-user mode.
  * Improved security and troubleshooting wording.
  * Polished MCP client guide for readability and consistency.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)

URL: NVIDIA#977

Signed-off-by: Yuchen Zhang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants