Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| BITCOIN_NETWORK | No | The Bitcoin network to use: mainnet, testnet, signet, or regtest | testnet |
| BITCOIN_CLI_PATH | No | Path to the bitcoin-cli binary | bitcoin-cli |
Capabilities
Server capabilities have not been inspected yet.
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| encode_op_return | Encode arbitrary data into OP_RETURN script format. Args:
data: Data to encode (string)
encoding: Encoding for the data ('utf-8', 'hex'). Default: 'utf-8'
Returns:
Dictionary with 'script_hex' containing the OP_RETURN script.
|
| decode_op_return | Parse OP_RETURN data from script hex. Args:
script_hex: OP_RETURN script as hex string
Returns:
Dictionary with 'data_hex' and 'data_utf8' (if decodable).
|
| build_op_return_transaction | Construct OP_RETURN output data for a transaction. This prepares the data for inclusion in a transaction but does not
create or broadcast the transaction itself.
Args:
data: Data to embed
encoding: Data encoding ('utf-8' or 'hex')
use_envelope: Whether to wrap in BTCD envelope format
envelope_type: Envelope type if use_envelope is True
('raw', 'text', 'json', 'hash', 'token', 'file')
Returns:
Dictionary with 'script_hex' for the OP_RETURN output.
|
| parse_envelope | Parse BTCD envelope structure from raw bytes. Args:
data_hex: Hex-encoded envelope data
Returns:
Dictionary with envelope fields: magic, version, type, payload_hex.
|
| get_node_info | Check connection and network status. Returns:
Dictionary with node information including connection status,
network, block height, and version.
|
| list_utxos | List available UTXOs for funding transactions. Args:
min_confirmations: Minimum confirmations required (default: 1)
min_amount: Minimum UTXO amount in BTC (default: 0.0)
Returns:
Dictionary with list of UTXOs.
|
| broadcast_transaction | Send signed transaction to the network. Args:
tx_hex: Signed transaction as hex string
dry_run: If True, only test without broadcasting (default: True)
max_fee_rate: Maximum fee rate in BTC/kB (optional)
Returns:
Dictionary with result. For dry_run, includes 'allowed' status.
For actual broadcast, includes 'txid'.
|
| get_transaction | Fetch transaction details. Args:
txid: Transaction ID (hash)
Returns:
Dictionary with transaction details.
|
| search_op_returns | Scan blocks for OP_RETURN transactions. Note: This is a placeholder that will require additional implementation
for block scanning. Currently returns an error indicating the feature
requires direct block access.
Args:
start_height: Starting block height
end_height: Ending block height (optional, defaults to start_height)
limit: Maximum number of results (default: 100)
Returns:
Dictionary with found OP_RETURN transactions.
|
| create_token_deploy | Create a BRC-20 token deployment inscription. Args:
tick: Token ticker (exactly 4 characters)
max_supply: Maximum token supply
mint_limit: Maximum amount per mint (optional)
decimals: Token decimals (default: 18)
Returns:
Dictionary with inscription data in various formats.
|
| create_token_mint | Create a BRC-20 token mint inscription. Args:
tick: Token ticker (exactly 4 characters)
amount: Amount to mint
Returns:
Dictionary with inscription data in various formats.
|
| create_token_transfer | Create a BRC-20 token transfer inscription. Args:
tick: Token ticker (exactly 4 characters)
amount: Amount to transfer
Returns:
Dictionary with inscription data in various formats.
|
| embed_document | Prepare a document for on-chain storage. Args:
content: Document content
content_type: MIME type of the content (default: 'text/plain')
encoding: Content encoding ('utf-8' or 'hex')
Returns:
Dictionary with prepared document data for embedding.
|
| read_document | Retrieve and parse document from transaction data. Args:
data_hex: Hex-encoded document data (from OP_RETURN)
Returns:
Dictionary with parsed document content.
|
| create_timestamp | Create a hash commitment for timestamping. Args:
data: Data to timestamp
encoding: Data encoding ('utf-8' or 'hex')
hash_algorithm: Hash algorithm to use ('sha256', 'sha3_256')
Returns:
Dictionary with hash and prepared script for embedding.
|
| verify_timestamp | Verify data against an on-chain timestamp hash. Args:
data: Original data to verify
expected_hash: Expected hash value (hex)
encoding: Data encoding ('utf-8' or 'hex')
hash_algorithm: Hash algorithm used ('sha256', 'sha3_256')
Returns:
Dictionary with verification result.
|
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |