Pop
- typescript
2
GitHub Stars
typescript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"r0gue-io-pop-mcp": {
"command": "/path/to/pop-mcp-server",
"args": [],
"env": {
"ENV": "PLACEHOLDER"
}
}
}
}You are equipped with the Pop MCP Server to enable seamless Polkadot development through natural language interactions. It connects your development tools, documentation, and command workflows so you can build contracts, parachains, pallets, and interact with the chain using an AI-assisted interface.
How to use
Install and run the Pop MCP Server, then connect it to your MCP client or IDE. You can load documentation resources, create and manage ink! contracts, launch parachains, build pallets, and call chain APIs through simple prompts. Use the available tools to check your environment, scaffold projects, build and test contracts, deploy on networks, and inspect contract metadata. You will also be able to search and retrieve documentation topics on ink!, XCM, and Pop CLI as part of your development workflow.
How to install
# macOS ARM64 (Apple Silicon)
curl -L https://github.com/r0gue-io/pop-mcp/releases/latest/download/pop-mcp-server-aarch64-apple-darwin.tar.gz | tar xz
chmod +x pop-mcp-server-aarch64-apple-darwin
# macOS Intel
curl -L https://github.com/r0gue-io/pop-mcp/releases/latest/download/pop-mcp-server-x86_64-apple-darwin.tar.gz | tar xz
chmod +x pop-mcp-server-x86_64-apple-darwin
# Linux
curl -L https://github.com/r0gue-io/pop-mcp/releases/latest/download/pop-mcp-server-x86_64-unknown-linux-gnu.tar.gz | tar xz
chmod +x pop-mcp-server-x86_64-unknown-linux-gnu
Move the binary to a location in your PATH (optional):
sudo mv pop-mcp-server-* /usr/local/bin/pop-mcp-server
# Build from source
# Clone the repository
git clone https://github.com/r0gue-io/pop-mcp.git
cd pop-mcp
# Build with Rust
cargo build --release
# The binary will be at target/release/pop-mcp-server
Configuration and usage notes
Configure your MCP client or editor to load the Pop MCP Server as an stdio-based endpoint. You typically provide the path to the server binary and any environment variables required by your setup.
{
"mcpServers": {
"pop-mcp": {
"type": "stdio",
"command": "/path/to/pop-mcp-server",
"args": [],
"env": {}
}
}
}
Replace "/path/to/pop-mcp-server" with the actual path to your binary, or use just pop-mcp-server if it is in your PATH.
## Troubleshooting and tips
If you run into issues, verify the build completed successfully, confirm the MCP client is pointing to the correct path, and check logs for errors. Restart the MCP client after any configuration changes.
## Tools and development workflow
You can access a wide range of tools to manage contracts, parachains, pallets, and chain interactions. Use them to instantiate, test, deploy, and query Polkadot runtime components, as well as to search and reference documentation on ink!, XCM, and Pop CLI.
## Documentation resource loading (optional)
Optional automatic loading of documentation resources can be configured so your conversations include ink!, Pop CLI, and XCM guidance without manual prompting.
## Cursor, Claude, and other MCP clients configuration
Use the MCP server by configuring the client to load the server via stdio. The following examples show how you can declare the server within client configuration files.
{ "pop-mcp": { "type": "stdio", "command": "/path/to/pop-mcp-server", "args": [], "env": {} } }
Replace "/path/to/pop-mcp-server" with the actual path to your binary, or just `pop-mcp-server` if it's in your PATH.
Available tools
check_pop_installation
Verify Pop CLI installation and version information.
install_pop_instructions
Provide platform-specific installation steps for Pop CLI.
list_templates
List available ink! contract templates such as ERC20, ERC721, and more.
create_contract
Create a new ink! contract from a selected template.
build_contract
Build a contract project, optionally with optimizations.
test_contract
Run unit or end-to-end tests for a contract.
deploy_contract
Deploy a contract to a specified node or network.
call_contract
Call a method on a deployed contract.
get_contract_info
Retrieve contract metadata and information.
create_parachain
Create a new parachain or appchain project.
build_parachain
Build parachain binaries and runtime.
launch_parachain
Launch local parachain networks.
create_pallet
Create a new runtime pallet.
benchmark_pallet
Benchmark a pallet to evaluate performance.
call_chain
Execute extrinsics, query storage, and read constants on the chain.
query_chain_storage
Read chain storage state.
read_chain_constant
Read runtime constants from the chain.
clean_project
Clean build artifacts from a project.
pop_help
Get help for any Pop CLI command.
search_documentation
Search across all documentation topics and keywords.