Skip to content

Conversation

akolotov
Copy link
Collaborator

@akolotov akolotov commented Jul 21, 2025

Summary

  • deprecate REST endpoint for get_address_logs
  • remove tool registration from server
  • document deprecation and clean references
  • update llms.txt, index page, DXT manifest
  • add deprecation test and helper

Closes #168


https://chatgpt.com/codex/tasks/task_b_687ec2ea40e88323b9185cfcd8d5689a

Summary by CodeRabbit

  • New Features

    • The API now returns a clear deprecation notice for requests to the /v1/get_address_logs endpoint, including guidance on alternative workflows.
  • Documentation

    • Updated documentation and user guides to mark get_address_logs as deprecated and removed references to it across all docs and help pages.
  • Chores

    • Removed get_address_logs from tool lists, manifests, server registration, and UI tool listings.
    • Updated tests to verify deprecation behavior for the affected endpoint.

Copy link

coderabbitai bot commented Jul 21, 2025

Walkthrough

The get_address_logs tool has been deprecated and removed from the MCP interface, and its REST API endpoint now returns a static deprecation notice. All documentation, manifests, and tool lists have been updated to reflect this change. The source code for get_address_logs remains, but with a deprecation comment. Related tests and helper logic were updated accordingly.

Changes

Files/Paths Change Summary
README.md, AGENTS.md, blockscout_mcp_server/llms.txt, blockscout_mcp_server/templates/index.html Removed get_address_logs from tool lists and documentation.
API.md Updated get_address_logs endpoint docs to mark as deprecated and show new static response.
SPEC.md Removed example JSON response related to paginated tool responses.
dxt/manifest.json Removed get_address_logs from the manifest tool list.
blockscout_mcp_server/server.py Unregistered get_address_logs from MCP server and removed import.
blockscout_mcp_server/api/routes.py Updated /v1/get_address_logs endpoint to return a deprecation notice; removed tool invocation.
blockscout_mcp_server/api/helpers.py Added create_deprecation_response helper for standardized deprecation notices.
blockscout_mcp_server/tools/address_tools.py Added deprecation comment above get_address_logs; no functional changes.
tests/api/test_routes.py Replaced endpoint tests with a single test for the deprecation response.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant REST_API
    participant Helpers

    Client->>REST_API: GET /v1/get_address_logs
    REST_API->>Helpers: create_deprecation_response()
    Helpers-->>REST_API: Deprecation ToolResponse (HTTP 410)
    REST_API-->>Client: Deprecation notice response
Loading

Estimated code review effort

2 (~15 minutes)

Possibly related PRs


📜 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 7f9822b and a764a8d.

📒 Files selected for processing (3)
  • AGENTS.md (2 hunks)
  • blockscout_mcp_server/tools/address_tools.py (1 hunks)
  • tests/api/test_routes.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • AGENTS.md
  • blockscout_mcp_server/tools/address_tools.py
  • tests/api/test_routes.py
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Docker build and docker push
✨ 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.

@akolotov akolotov requested a review from Copilot July 21, 2025 23:58
Copy link

@Copilot 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 deprecates the get_address_logs endpoint by removing it from the MCP tool interface while maintaining backward compatibility for REST API users. The change addresses LLM misuse patterns where this tool was preferred over the more efficient workflow of using get_transactions_by_address followed by get_transaction_logs.

  • Removes get_address_logs from MCP server tool registration and manifests
  • Converts REST endpoint to return a static 410 deprecation notice with guidance
  • Updates all documentation to reflect the deprecation and removal

Reviewed Changes

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

Show a summary per file
File Description
blockscout_mcp_server/server.py Removes get_address_logs import and tool registration
blockscout_mcp_server/api/routes.py Replaces endpoint logic with deprecation response
blockscout_mcp_server/api/helpers.py Adds helper function to generate standardized deprecation responses
blockscout_mcp_server/tools/address_tools.py Adds deprecation comment explaining reasoning
tests/api/test_routes.py Replaces functional tests with deprecation behavior verification
dxt/manifest.json Removes tool from DXT manifest
Multiple documentation files Updates to remove references and document deprecation

@akolotov akolotov merged commit d2ce97b into main Jul 22, 2025
8 checks passed
@akolotov akolotov deleted the codex/deprecate-get_address_logs-tool branch July 22, 2025 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate get_address_logs from MCP and update REST endpoint
1 participant