Skip to content

Conversation

@JayaSurya-27
Copy link
Collaborator

@JayaSurya-27 JayaSurya-27 commented May 30, 2025

Pull Request

Description

Describe the changes in this pull request:

  • What feature/bug does this PR address?
  • Provide any relevant links or screenshots.

Checklist

  • Code compiles correctly.
  • Created/updated tests.
  • Linting and formatting applied.
  • Documentation updated.

Related Issues

Closes #<issue_number>

Summary by CodeRabbit

  • New Features
    • Introduced OpenTelemetry tracing integration for MCP, enabling context propagation and distributed tracing across MCP transports and sessions.
    • Added support for instrumenting MCP client and server message streams for enhanced observability.
  • Documentation
    • Expanded and restructured the README for improved clarity, detailed features, supported frameworks, contribution guidelines, and additional resources.
  • Chores
    • Added configuration and metadata files for the new MCP tracing package, including versioning and dependency declarations.

NVJKKartik and others added 2 commits May 30, 2025 16:27
[Feature] MCP (Model Context Protocol) Instrumentation Support For Python SDK
@coderabbitai
Copy link

coderabbitai bot commented May 30, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The update introduces a new OpenTelemetry instrumentation package for MCP, featuring comprehensive context propagation for MCP transports and sessions. It adds package metadata, versioning, and dependency declarations. The README is significantly expanded and restructured for clarity, detailing features, supported frameworks, and contribution guidelines, with no changes to core code entities outside the new MCP integration.

Changes

File(s) Change Summary
README.md Expanded and restructured documentation: clarified description, added features, frameworks table, contribution, resources
python/frameworks/mcp/pyproject.toml Added Poetry-based package configuration for traceAI-mcp, specifying dependencies and metadata
python/frameworks/mcp/traceai_mcp/init.py New MCP OpenTelemetry instrumentor: wraps MCP streams for context propagation; adds multiple proxy and wrapper classes
python/frameworks/mcp/traceai_mcp/package.py Added _instruments tuple declaring MCP and futureagi package dependencies
python/frameworks/mcp/traceai_mcp/version.py Added version variable set to "0.1.0"

Sequence Diagram(s)

sequenceDiagram
    participant UserApp
    participant MCPClient
    participant MCPServer
    participant Instrumentor

    UserApp->>MCPClient: Send message (via instrumented writer)
    MCPClient->>Instrumentor: Inject tracing context into message
    MCPClient->>MCPServer: Transmit message with context
    MCPServer->>Instrumentor: Extract tracing context from message
    MCPServer->>UserApp: Process message with attached context
Loading

Poem

In tunnels of code where the traces flow,
A new instrumentor helps context to grow.
MCP streams now carry the thread,
Of distributed spans as messages are spread.
With docs refreshed and guidance anew,
The rabbit hops forward—tracing with you! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 250cb84 and 59f8b90.

📒 Files selected for processing (5)
  • README.md (3 hunks)
  • python/frameworks/mcp/pyproject.toml (1 hunks)
  • python/frameworks/mcp/traceai_mcp/__init__.py (1 hunks)
  • python/frameworks/mcp/traceai_mcp/package.py (1 hunks)
  • python/frameworks/mcp/traceai_mcp/version.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@NVJKKartik NVJKKartik merged commit 3321e33 into main May 30, 2025
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants