Skip to content

[codex] fix README MCP Python entrypoint example#252

Closed
codexbountylab wants to merge 1 commit into
Scottcjn:mainfrom
codexbountylab:codex/fix-readme-import-path
Closed

[codex] fix README MCP Python entrypoint example#252
codexbountylab wants to merge 1 commit into
Scottcjn:mainfrom
codexbountylab:codex/fix-readme-import-path

Conversation

@codexbountylab

Copy link
Copy Markdown
Contributor

Fix: README quick-start import path for Python MCP usage

Closes #250.

Bug

The README currently documents this Python entrypoint:

from rustchain_mcp import RustChainMCPServer

server = RustChainMCPServer(api_key="your-api-key")
server.run()

That symbol is not exported by the package, so following the quick-start example fails at import time.

Fix

  • Replace the broken example with the real package entrypoint: from rustchain_mcp.server import mcp
  • Show the environment variables the server expects before calling mcp.run()

Scope

Docs-only change in README.md.

Validation

  • Verified rustchain_mcp/__init__.py does not export RustChainMCPServer.
  • Verified the MCP server entrypoint is defined in rustchain_mcp/server.py as mcp = FastMCP(...).

RTC payout wallet: RTCc78142b4cc31531e913c4082bc5d771eb0a91ac1

@codexbountylab codexbountylab marked this pull request as ready for review July 2, 2026 02:37

@jaxint jaxint left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

PR Review

Reviewer: @jaxint
Wallet: AhqbFaPBPLMMiaLDzA9WhQcyvv4hMxiteLhPk3NhG1iG

Summary

This PR addresses: [codex] fix README MCP Python entrypoint example

Code Review

Changes Reviewed:

  • Files: 1
  • Lines: +11/-3

Assessment: ✅ Approved

The changes follow the project's coding standards and address the issue described in the PR title. The implementation is clean and minimal.

Testing

  • Code changes are minimal and focused
  • No additional test coverage required for this fix

Recommendation

APPROVE - Ready for merge.


Review submitted via RustChain Bounty System
RTC bounty claim: 40 RTC per review (Bounty #73)

@Scottcjn

Scottcjn commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Thanks for this. You correctly spotted that the README's documented import was pointing at a symbol that did not exist. I went with #253 because it fixes the root cause at the package level, re-exporting mcp from __init__ so the documented import works as written rather than only changing the docs. Closing this in favor of that one, but the diagnosis was right on the money. Grab another open bounty and keep them coming.

@Scottcjn Scottcjn closed this Jul 4, 2026
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.

README quick-start import path is broken: from rustchain_mcp import RustChainMCPServer fails

3 participants