Skip to content

fix: make README programmatic example importable (closes #250) #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Scottcjn merged 1 commit into from
Jul 4, 2026
Merged

fix: make README programmatic example importable (closes #250) #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,16 @@ Add to your Claude config file (`~/Library/Application Support/Claude/claude_des

### For Other MCP Clients

Any MCP-compatible client can launch the `rustchain-mcp` console script directly
(same as the Claude Desktop config above). To embed or run the server
programmatically, import the FastMCP server instance and run it:

```python
from rustchain_mcp import RustChainMCPServer
from rustchain_mcp import mcp

server = RustChainMCPServer(api_key="your-api-key")
server.run()
# Configuration is read from environment variables (all optional):
# RUSTCHAIN_NODE, BOTTUBE_URL, BEACON_URL, RUSTCHAIN_TIMEOUT
mcp.run() # serves over stdio by default
```

## Prerequisites
Expand Down
9 changes: 9 additions & 0 deletions rustchain_mcp/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
"""RustChain + BoTTube MCP Server — AI agent tools for the RustChain blockchain and BoTTube video platform."""

__version__ = "0.4.0"

# Re-export the FastMCP server instance so it can be used programmatically:
# from rustchain_mcp import mcp
# mcp.run()
# This is the same object the ``rustchain-mcp`` console script runs
# (see [project.scripts] in pyproject.toml -> rustchain_mcp.server:mcp.run).
from .server import mcp

__all__ = ["mcp", "__version__"]
Loading