API Reference
This document provides a detailed reference for the tools available in the Agentic Tools MCP Server. Each tool is designed to facilitate interactions with various components of the Hyperweb and Cosmos ecosystems.
Chain Registry Tools
Tools for accessing and managing information from chain registries.
useChainRegistry
- Description: This tool provides comprehensive examples and usage patterns for the Chain Registry, call this tool for any Chain Registry implementation guidance.
- Source:
src/chain-registry/tools/use-chain-registry.ts
- Parameters:
majorVersion
(enum:v1
|v2
, required): The major version of the Chain Registry to use.
- Output: Provides text content with examples and usage patterns for the specified Chain Registry version.
Interchain Kit Tools
Tools related to Interchain Kit, including usage guidance and migration assistance.
useInterchainKit
- Description: This tool provides comprehensive examples and usage patterns for the Interchain Kit, call this tool for any Interchain Kit implementation guidance.
- Source:
src/interchain-kit/tools/use-interchain-kit.ts
- Parameters:
framework
(enum:react
|vue
, required): The frontend framework of the project.
- Output: Provides text content with examples and usage patterns for Interchain Kit tailored to the specified framework.
migrateFromCosmosKitToInterchainKit
- Description: Migrate a project from CosmosKit to InterchainKit using the provided migration guide. The user's code to be migrated is expected to be available in the IDE context.
- Source:
src/interchain-kit/tools/migrate-from-cosmos-kit-to-interchain-kit.ts
- Parameters: None.
- Output: Provides text content containing the CosmosKit to InterchainKit migration guide.
InterchainJS Tools
Tools for leveraging InterchainJS, including usage guidance and migration assistance from CosmJS.
useInterchainjs
- Description: This tool provides comprehensive examples and usage patterns for the InterchainJS library, call this tool for any InterchainJS implementation guidance.
- Source:
src/interchainjs/tools/use-interchainjs.ts
- Parameters: None.
- Output: Provides text content with examples and usage patterns for the InterchainJS library.
migrateToInterchainjs
- Description: Migrate CosmJS code to InterchainJS. REQUIRES the project's package manager (npm, yarn, or pnpm) to be correctly specified for proper dependency installation commands.
- Source:
src/interchainjs/tools/migrate-to-interchainjs.ts
- Parameters:
packageManager
(enum:npm
|yarn
|pnpm
, required): The package manager detected in the target project. This value MUST be correctly determined and provided by the caller.
- Output: Provides text content containing a migration guide from CosmJS to InterchainJS, including API mappings and code examples, tailored for the specified package manager.
Starship Tools
Tools for interacting with Starship, the unified development and testing environment for Cosmos chains. This includes setup assistance and configuration generation.
setupStarship
- Description: Setup and use Starship in a project.
- Source:
src/starship/tools/starship-setup.ts
- Parameters: None.
- Output: Provides text content with a guide for setting up Starship.
generateStarshipConfig
- Description: Generates a Starship configuration file in YAML format based on detailed input options then creates the file (e.g.,
starship/config.yaml
) in the workspace. - Source:
src/starship/tools/starship-config-gen.ts
- Parameters (StarshipConfigInput):
configFilePath
(string, required): The absolute path to the Starship configuration file (e.g.,<current_working_directory>/starship/config.yaml
).configName
(string, optional, default: "starship"): Top-level configuration name.configVersion
(string, optional, default: "1.6.0"): Top-level configuration version.chains
(array of ChainConfig, required, min: 1): List of chain configurations. EachChainConfig
includes:id
(string, required): Unique identifier for the chain.name
(string, required): Type of chain (e.g., 'osmosis', 'custom').numValidators
(integer, required, positive): Number of validators.image
(string, optional): Override default Docker image.home
(string, optional): Home directory path (forname: 'custom'
).binary
(string, optional): Binary name (forname: 'custom'
).prefix
(string, optional): Address prefix (forname: 'custom'
).denom
(string, optional): Primary denomination (forname: 'custom'
).coins
(string, optional): Genesis coins.hdPath
(string, optional): HD path.coinType
(integer, optional): Coin type.repo
(string URL, optional): Git repository URL.ports
(object, optional): Port forwarding (rest
,rpc
,grpc
,faucet
,exposer
).resources
(object, optional): CPU/memory allocation (cpu
,memory
).faucet
(object, optional): Faucet config (enabled
,type
,image
,concurrency
,resources
).build
(object, optional): On-the-fly build config (enabled
,source
).upgrade
(object, optional): Upgrade prep config (enabled
,type
,genesis
,upgrades
array).genesis
(object, optional):genesis.json
patches (app_state
).scripts
(object, optional): Override setup scripts.cometmock
(object, optional): CometMock config (enabled
,image
).env
(array of EnvVar, optional): Custom environment variables (name
,value
).ics
(object, optional): ICS config for consumer chains (enabled
,provider
).balances
(array of BalanceEntry, optional): Initial balances (address
,amount
).readinessProbe
(object, optional): Custom readiness probe.config
(object, optional): Ethereum-specific config (ifname
is 'ethereum').
relayers
(array of RelayerConfig, optional): List of relayer configurations. EachRelayerConfig
includes:name
(string, required): Name for the relayer instance.type
(enum:hermes
|ts-relayer
|go-relayer
|neutron-query-relayer
, required): Type of relayer.image
(string, optional): Override default Docker image.replicas
(integer, optional, default: 1): Number of replicas (currently 1).chains
(array of string, required, min: 2): Chain IDs to connect.config
(object, optional): Hermes specificconfig.toml
overrides.ports
(object, optional): Hermes specific port forwarding (rest
,exposer
).ics
(object, optional): Hermes specific ICS setup.
explorer
(ExplorerConfig, optional): Explorer configuration (enabled
,type
,ports
,resources
,image
).registry
(RegistryConfig, optional): Registry service configuration (enabled
,localhost
,ports
,resources
,image
).
- Output: Text confirmation with the generated YAML content and writes the file to the specified
configFilePath
.
verifyStarshipConfig
- Description: Parses and validates a Starship configuration YAML string against the known schema.
- Source:
src/starship/tools/starship-config-gen.ts
- Parameters (VerifyStarshipConfigInput):
configFilePath
(string, required): The absolute path to the Starship configuration file.yamlContent
(string, required): The Starship configuration content in YAML format as a string.
- Output: Text indicating if the configuration is valid or invalid, with error details if invalid.
Utility Tools
(Placeholder: Currently no tools from src/utils/
are explicitly registered as MCP tools in the provided snippets. If createTool
in src/utils/tool-helpers.js
is used to register tools directly or if other files in utils
register tools, they should be added here.)
Note: The parameters listed are based on the Zod schemas in the tool definitions. For complex object parameters like ChainConfig
or RelayerConfig
within generateStarshipConfig
, refer to the source file (src/starship/tools/starship-config-gen.ts
) for the full nested structure and descriptions of each field.