Skip to content

Consolidate MCP client and server docs, examples#246

Merged
rapids-bot[bot] merged 11 commits intoNVIDIA:developfrom
AnuradhaKaruppiah:mcp-cleanup
May 13, 2025
Merged

Consolidate MCP client and server docs, examples#246
rapids-bot[bot] merged 11 commits intoNVIDIA:developfrom
AnuradhaKaruppiah:mcp-cleanup

Conversation

@AnuradhaKaruppiah
Copy link
Contributor

@AnuradhaKaruppiah AnuradhaKaruppiah commented May 13, 2025

  1. Renamed components/mcp.md to guides/mcp-client.md
  2. Moved examples/mcp_server contents to examples/simple_calculator/deploy_external_mcp
  3. Deleted examples/simple_mcp. It is redundant and replaced by examples/simple_calculator/config-mcp-[date/math].yml
  4. Reformatted guides/mcp-client.md and guides/mcp-server.md to have a similar/more-unified flow

Description

Closes

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.

Move the instructions to the simple_calculator example directory.
simple_calculator will be the primary mcp-client example and this is the
first step in consolidating.

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
@AnuradhaKaruppiah AnuradhaKaruppiah self-assigned this May 13, 2025
@AnuradhaKaruppiah AnuradhaKaruppiah added improvement Improvement to existing functionality non-breaking Non-breaking change labels May 13, 2025
@AnuradhaKaruppiah AnuradhaKaruppiah marked this pull request as draft May 13, 2025 00:14
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
@AnuradhaKaruppiah AnuradhaKaruppiah marked this pull request as ready for review May 13, 2025 01:59
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
@AnuradhaKaruppiah AnuradhaKaruppiah requested a review from Copilot May 13, 2025 02:24
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR consolidates the documentation for MCP client and server by renaming, moving, and reformatting files to provide a unified flow.

  • Renamed and reorganized documentation files for clarity
  • Updated configuration examples to use "localhost" rather than "0.0.0.0"
  • Removed redundant example files and adjusted Dockerfile copy paths

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
examples/simple_calculator/src/aiq_simple_calculator/configs/config-mcp-math.yml Updated MCP math config URLs from "0.0.0.0" to "localhost"
examples/simple_calculator/src/aiq_simple_calculator/configs/config-mcp-date.yml Updated MCP date config URL from "0.0.0.0" to "localhost"
examples/simple_calculator/deploy_external_mcp/README.md Corrected the Dockerfile source path for external MCP deployment
examples/simple_calculator/README.md Added new sections for MCP Client and Server, and removed deprecated MCP service details
docs/source/guides/mcp-server.md Renamed and reformatted content to clearly represent MCP Server usage
docs/source/guides/mcp-client.md Reorganized MCP Client guide, updated sample configurations and schema names
docs/source/guides/index.md Updated guide index to include MCP Client and MCP Server entries
docs/source/components/index.md Removed outdated MCP component reference

Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
@AnuradhaKaruppiah AnuradhaKaruppiah changed the title Consolidate MCP client and server docs Consolidate MCP client and server docs/examples May 13, 2025
@AnuradhaKaruppiah AnuradhaKaruppiah changed the title Consolidate MCP client and server docs/examples Consolidate MCP client and server docs, examples May 13, 2025
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Copy link
Contributor

@dagardner-nv dagardner-nv left a comment

Choose a reason for hiding this comment

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

LGTM

@AnuradhaKaruppiah
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit f51516e into NVIDIA:develop May 13, 2025
10 checks passed
@AnuradhaKaruppiah AnuradhaKaruppiah deleted the mcp-cleanup branch May 13, 2025 16:03
ericevans-nv pushed a commit to ericevans-nv/agent-iq that referenced this pull request Jun 3, 2025
Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/advanced/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.

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

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

URL: NVIDIA#246
Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com>
ericevans-nv pushed a commit to ericevans-nv/agent-iq that referenced this pull request Jun 3, 2025
Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/advanced/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.

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

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

URL: NVIDIA#246
Signed-off-by: Eric Evans <194135482+ericevans-nv@users.noreply.github.com>
AnuradhaKaruppiah added a commit to AnuradhaKaruppiah/oss-agentiq that referenced this pull request Aug 4, 2025
Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/advanced/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.

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

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

URL: NVIDIA#246
scheckerNV pushed a commit to scheckerNV/aiq-factory-reset that referenced this pull request Aug 22, 2025
Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/advanced/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.

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

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

URL: NVIDIA#246
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvement to existing functionality non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants