{"id":27766471,"url":"https://github.com/moncho/bitcoin-mcp","last_synced_at":"2025-04-29T17:31:42.862Z","repository":{"id":287983752,"uuid":"961165481","full_name":"moncho/bitcoin-mcp","owner":"moncho","description":"A Bitcoin MCP Server","archived":false,"fork":false,"pushed_at":"2025-04-14T15:55:05.000Z","size":41,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T18:54:22.273Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moncho.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-05T22:30:53.000Z","updated_at":"2025-04-11T20:12:13.000Z","dependencies_parsed_at":"2025-04-15T01:11:52.875Z","dependency_job_id":"ca8204ad-09be-491f-a428-8d24d7df3e85","html_url":"https://github.com/moncho/bitcoin-mcp","commit_stats":null,"previous_names":["moncho/bitcoin-mcp"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moncho%2Fbitcoin-mcp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moncho%2Fbitcoin-mcp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moncho%2Fbitcoin-mcp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moncho%2Fbitcoin-mcp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moncho","download_url":"https://codeload.github.com/moncho/bitcoin-mcp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251549201,"owners_count":21607367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-04-29T17:31:17.441Z","updated_at":"2025-04-29T17:31:42.841Z","avatar_url":"https://github.com/moncho.png","language":"Go","funding_links":[],"categories":["⚙️ DevOps"],"sub_categories":[],"readme":"# Bitcoin MCP Server\n\nA Go-based service that provides a unified interface to interact with a Bitcoin node through various RPC commands using the Model Context Protocol (MCP). The server organizes Bitcoin RPC functionality into logical categories and provides a clean, well-documented API for accessing blockchain data and operations.\n\n## Features\n\n- Comprehensive Bitcoin RPC interface using Model Context Protocol\n- Organized by functional categories:\n  - Blockchain operations\n  - Mempool operations\n  - UTXO operations\n  - Blockchain management\n- Secure authentication\n- Comprehensive error handling\n- Clean and documented API\n\n## Prerequisites\n\n- Go 1.24 or later\n- Bitcoin Core node with RPC enabled\n- Basic understanding of Bitcoin RPC commands\n\n## Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/moncho/bitcoin-mcp.git\ncd bitcoin-mcp\n```\n\n2. Install dependencies:\n```bash\ngo mod download\n```\n\n3. Build the server:\n```bash\ngo build -o bitcoin-mcp\n```\n\n## Configuration\n\nCreate a configuration file (`config.json`) with the following structure:\n\n```json\n{\n    \"bitcoin\": {\n        \"rpc_url\": \"http://localhost:8332\",\n        \"username\": \"your_rpc_username\",\n        \"password\": \"your_rpc_password\"\n    },\n    \"server\": {\n        \"port\": 8080,\n        \"host\": \"localhost\"\n    }\n}\n```\n\n## Running the Server\n\n1. Start your Bitcoin Core node with RPC enabled:\n```bash\nbitcoind -server -rpcuser=your_rpc_username -rpcpassword=your_rpc_password\n```\n\n2. Start the MCP server:\n```bash\n./bitcoin-mcp -config config.json\n```\n\nOr using environment variables:\n```bash\nBITCOIN_RPC_URL=http://localhost:8332 \\\nBITCOIN_RPC_USER=your_rpc_username \\\nBITCOIN_RPC_PASS=your_rpc_password \\\n./bitcoin-mcp\n```\n\n## API Usage\n\nThe server provides a RESTful API for accessing Bitcoin RPC commands. Here are some examples:\n\n### Get Blockchain Information\n```bash\ncurl -X POST http://localhost:8080/api/v1/blockchain/info\n```\n\n### Get Block Data\n```bash\ncurl -X POST http://localhost:8080/api/v1/blockchain/block \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"blockhash\": \"0000000000000000000123456789abcdef\", \"verbose\": true}'\n```\n\n### Get Mempool Information\n```bash\ncurl -X POST http://localhost:8080/api/v1/mempool/info\n```\n\n## Development\n\n### Project Structure\n```\nbitcoin-mcp/\n├── cmd/\n│   └── server/          # Main server application\n├── pkg/\n│   ├── bitcoin/         # Bitcoin RPC client\n│   └── tools/           # RPC command implementations\n├── config.json          # Configuration file\n└── README.md           # This file\n```\n\n### Adding New RPC Commands\n\n1. Add the method to the Bitcoin client in `pkg/bitcoin/client.go`\n2. Create or update the corresponding tool in `pkg/tools/`\n3. Register the tool in the appropriate category\n4. Add tests for the new functionality\n\n## Testing\n\nRun the test suite:\n```bash\ngo test ./...\n```\n\n## Security Considerations\n\n- Never expose RPC credentials in public repositories\n- Use secure passwords for RPC access\n- Consider rate limiting for public APIs\n- Validate all input parameters\n- Sanitize error messages\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a Pull Request\n\nPlease follow the [Contributing Guidelines](CONTRIBUTING.md) when submitting changes.\n\n## Documentation\n\nFor detailed API documentation and specifications, see:\n- [API Specification](SPEC.md)\n- [GoDoc Documentation](https://godoc.org/github.com/moncho/bitcoin-mcp)\n\n## License\n\n[Specify License Information]\n\n## Support\n\nFor support, please:\n1. Check the [documentation](SPEC.md)\n2. Search existing issues\n3. Create a new issue if needed\n\n## Acknowledgments\n\n- Bitcoin Core developers\n- Go community\n- All contributors to this project\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoncho%2Fbitcoin-mcp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoncho%2Fbitcoin-mcp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoncho%2Fbitcoin-mcp/lists"}