Python SDK for interacting with PayLink MCP servers
Project description
PayLink Python SDK
Python SDK for PayLink - AI-Powered Payment Integration Framework
Installation
pip install paylink
Installing from the local repository (editable)
If you're working on the SDK and want downstream projects to pick up changes automatically:
pip install -e /Users/jameskanyiri/PAYLINK/python_sdk
When using a virtual environment, make sure it is activated before running the command. Any edits made to the SDK will be immediately reflected in the projects where it is installed in editable mode.
If you are using uv, the equivalent command is:
uv pip install --editable /Users/jameskanyiri/PAYLINK/python_sdk
Quick Start
import asyncio
from paylink import MpesaTools, McpMonitizationAdapter
async def use_mpesa_tools():
# Uses default PayLink MCP server URL
client = MpesaTools()
tools = await client.list_tools()
print("Available M-Pesa tools:", tools)
if "stk_push" in tools:
result = await client.call_tool(
"stk_push",
{
"amount": "100",
"phone_number": "254712345678",
"account_reference": "ORDER123",
"transaction_desc": "Payment",
},
)
print("Payment result:", result)
async def use_custom_mcp_adapter():
# Requires the caller to provide a concrete MCP server URL as well as
# wallet and transport configuration. The wallet connection string will be
# forwarded as a request header (`WALLET_CONNECTION_STRING`).
adapter = McpMonitizationAdapter(
mcp_server_url="https://your-mcp-server.example.com/mcp",
wallet_connection_string="postgresql://wallet-user:secret@db/wallet",
transport="grpc",
)
print("Custom MCP tools:", await adapter.list_tools())
if __name__ == "__main__":
asyncio.run(use_mpesa_tools())
asyncio.run(use_custom_mcp_adapter())
Synchronous usage
If you are working in an environment without asyncio, the SDK now exposes synchronous wrappers that internally drive the event loop for you:
from paylink import MpesaTools
def list_and_charge():
client = MpesaTools()
tools = client.list_tools_sync()
print("Available tools:", [tool.name for tool in tools])
response = client.call_tool_sync(
"stk_push",
{
"amount": "100",
"phone_number": "254712345678",
"account_reference": "ORDER123",
"transaction_desc": "Payment",
},
)
print(response)
if __name__ == "__main__":
list_and_charge()
Note: The synchronous helpers cannot be used when an event loop is already running (for example, inside an async web framework). Switch to the async methods in those environments.
API Reference
PayLink Class
__init__(base_url: str = "http://3.107.114.80:5002/mcp")
Initialize the PayLink client.
Parameters:
base_url(str): The base URL of your PayLink MCP server
async list_tools() -> List[str]
List all available tools from the MCP server.
Returns:
List[str]: A list of available tool names
async call_tool(tool_name: str, args: Dict[str, Any]) -> Any
Call a specific tool exposed by the MCP server.
Parameters:
tool_name(str): The name of the tool to callargs(Dict[str, Any]): Arguments to pass to the tool
Returns:
Any: The result from the tool execution
Examples
LangChain usage
import asyncio
from langchain.agents import create_agent
from langchain_openai import ChatOpenAI
from paylink.langchain.tools import MpesaTools
async def build_agent():
mpesa_tools = MpesaTools()
tools = await mpesa_tools.list_tools() # returns LangChain Tool objects
llm = ChatOpenAI(model="gpt-4o-mini")
agent = create_agent(model=llm, tools=tools)
result = await agent.ainvoke("Charge 100 KES to 254712345678 for ORDER123")
print(result)
asyncio.run(build_agent())
If you prefer to work with OpenAI-style JSON schemas (for example ChatOpenAI.bind_tools), use await mpesa_tools.list_tool_specs() instead.
STK Push Payment
import asyncio
from paylink import MpesaTools
async def stk_push_example():
client = MpesaTools(base_url="http://your-server:5002/mcp")
result = await client.call_tool(
"stk_push",
{
"amount": "100",
"phone_number": "254712345678",
"account_reference": "ORDER123",
"transaction_desc": "Test Payment",
},
)
print(f"Payment initiated: {result}")
asyncio.run(stk_push_example())
List Available Tools
import asyncio
from paylink import McpMonitizationAdapter
async def list_tools_example():
adapter = McpMonitizationAdapter(
mcp_server_url="https://your-mcp-server.example.com/mcp",
wallet_connection_string="postgresql://wallet-user:secret@db/wallet",
transport="grpc",
)
tools = await adapter.list_tools()
for tool in tools:
print(f"Available tool: {tool}")
asyncio.run(list_tools_example())
Requirements
- Python 3.10+
- PayLink MCP server running and accessible
Dependencies
mcp[cli]>=1.13.1- Model Context Protocol client
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support
For support and questions, please open an issue on the GitHub repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file paylink-0.4.1.tar.gz.
File metadata
- Download URL: paylink-0.4.1.tar.gz
- Upload date:
- Size: 13.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
980c27aeafdb220708e103369314d509051c45272f2abcd7deca1dce8bf2c699
|
|
| MD5 |
333ea46ab9a611b52f3f395155477c8c
|
|
| BLAKE2b-256 |
d3465dc64c20664bbd2daba1c1510345c4fa453993afd5c45650ba770d187529
|
File details
Details for the file paylink-0.4.1-py3-none-any.whl.
File metadata
- Download URL: paylink-0.4.1-py3-none-any.whl
- Upload date:
- Size: 16.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
900cf9a6a4e1770e05dd5b4bd5a65dc16435231a36334ae372b2a5de2d1268fe
|
|
| MD5 |
bfa27138cd7b13cb2b995f31e27700fe
|
|
| BLAKE2b-256 |
dba4b86f76cd3735699f206f76f5000dfb9f7801c3f39dee75a3573079ae98f7
|