Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.inkwell.finance/llms.txt

Use this file to discover all available pages before exploring further.

​
Agent Skill Installer

The Inkwell Agent API can be consumed by AI agents through multiple discovery mechanisms.

​
Claude Code Skill

The Inkwell repo includes a native Claude Code skill that teaches Claude how to use the staking API interactively.

​
Installation

Clone the skill into your Claude Code skills directory: 
cp -r .claude/skills/leviathan-agent ~/.claude/skills/
Or if working within the Inkwell repo, it’s already available. Invoke it with: 
/leviathan-agent
The skill provides:
  • Decision logic for when to call each endpoint
  • Multi-step workflows (allocate -> build tx -> sign -> submit)
  • Tier-aware behavior (knows which features require builder/pro)

​
MCP Server

The @inkwell.finance/mcp-ika-staking package exposes the full API as MCP tools and resources.

​
Installation

npm install -g @inkwell.finance/mcp-ika-staking

​
Configuration

Add to your MCP client config (e.g., claude_desktop_config.json): 
{
  "mcpServers": {
    "ika-staking": {
      "command": "mcp-ika-staking",
      "env": {
        "IKA_STAKING_API_KEY": "ink_your_key_here",
        "IKA_STAKING_API_URL": "https://backend.inkwell.finance/api/v1/ika/agent"
      }
    }
  }
}

​
Available tools

ToolDescription
ika_healthCheck API health
ika_metadataGet network configuration
ika_validators_scoredGet scored validator list
ika_allocateCompute optimal allocation
ika_tx_stakeBuild stake transaction params
ika_tx_unstakeBuild unstake transaction params
ika_tx_withdrawBuild withdraw transaction params
ika_rebalanceGet rebalance plan
ika_delegatorsGet delegator list

​
Available resources

ResourceDescription
ika://validatorsFull validator set (public)
ika://epochCurrent epoch data
ika://priceLatest IKA price

​
OpenAPI Spec

The raw OpenAPI 3.1 spec is available for any agent framework that consumes OpenAPI: 
https://docs.inkwell.finance/openapi/leviathan.yaml

​
Agent discovery

The API serves a plugin manifest for generic agent discovery: 
https://backend.inkwell.finance/.well-known/ai-plugin.json
This follows the OpenAI plugin convention and points to the OpenAPI spec.

​
Environment variables

VariableDefaultDescription
IKA_STAKING_API_URLhttps://backend.inkwell.finance/api/v1/ika/agentAgent API base URL
IKA_STAKING_API_KEY(none)Your API key