Official paths to connect payments, yield, orders, and KYC to assistants and agents—without reverse-engineering the API.
Documentation · Getting started & KYC · LLM index · Dashboard
StarkFi exposes a production HTTP API at https://api.starkfi.io for StarkPay, yield, orders, and KYC. For teams building with Cursor, Claude Desktop, Claude Code, or any MCP-compatible client, we publish a typed Model Context Protocol surface and agent skills so models call validated tools instead of improvising requests.
This page is the entry map: choose a path, copy the minimum configuration, and link out to the repositories for depth.
flowchart TB
subgraph inputs["What you have"]
A[StarkFi API key]
B[Node.js 20+]
end
subgraph paths["Choose your integration path"]
C["Path A — Guided setup\nCursor · Claude Desktop · Claude Code"]
D["Path B — MCP only\nAny MCP host"]
E["Path C — HTTP & docs\nNo MCP"]
end
subgraph outputs["Result"]
F["Skills + MCP registered\nAgents use starkfi tools"]
G["starkfi-mcp on stdio\nZod-validated tool catalog"]
H["REST + llms.txt\nGrounded prompts & RAG"]
end
A --> paths
B --> paths
C --> F
D --> G
E --> H
style inputs fill:#f6f8fa,stroke:#d0d7de
style paths fill:#fff8f0,stroke:#d0d7de
style outputs fill:#f0fff4,stroke:#d0d7de
| Section | Description |
|---|---|
| Prerequisites | API key, runtime, compliance |
| Path A — One-command setup | Fastest for Cursor & Claude |
| Path B — MCP server | Bring your own MCP client |
| Path C — Documentation | Direct HTTP and llms.txt |
| Tool catalog | Domain prefixes at a glance |
| Agent skills | Cursor SKILL.md bundles |
| Security | Secrets and configuration hygiene |
| Repositories | Source and issue trackers |
| Requirement | Specification |
|---|---|
| API credential | STARKFI_API_KEY — HTTP header x-api-key on all API calls. Issue and rotate keys in the StarkFi dashboard. |
| Runtime | Node.js 20 or newer for starkfi-mcp and setup tooling. |
| Product readiness | Account, environment, and KYC steps per Getting started before exercising live flows. |
Best for: teams on Cursor and Claude Desktop who want agent skills and MCP wired consistently on developer machines.
The starkfi-agent-skills package copies official Cursor Agent Skills and merges the StarkFi MCP server into host configuration.
| Step | Action |
|---|---|
| 1 | Export your API key: export STARKFI_API_KEY="your_key_here" |
| 2 | Run: npx starkfi-agent-skills setup |
| 3 | Fully restart Cursor and Claude Desktop so MCP definitions reload |
CI and automation:
STARKFI_API_KEY="your_key_here" npx starkfi-agent-skills setup --yesWhat gets configured
| Host | Outcome |
|---|---|
| Cursor | Skills under ~/.cursor/skills/ · mcpServers.starkfi in ~/.cursor/mcp.json invoking npx -y starkfi-mcp |
| Claude Desktop (macOS) | ~/Library/Application Support/Claude/claude_desktop_config.json updated with the same MCP entry |
| Claude Code | Optional project .mcp.json — use --claude-code-project or the CLI flow documented in the repo |
References: GitHub — starkfi-agent-skills · npm — starkfi-agent-skills
Best for: custom agents, IDEs, or platforms that already speak MCP over stdio and only need the StarkFi tool surface.
starkfi-mcp is the published package from starkfi-mcp-agent: TypeScript, ESM, Zod-validated tools, default base URL https://api.starkfi.io (override with STARKFI_BASE_URL).
| Step | Command |
|---|---|
| Run | STARKFI_API_KEY="your_key_here" npx -y starkfi-mcp |
| Pin version | STARKFI_API_KEY="your_key_here" npx -y starkfi-mcp@x.y.z |
Environment variables
| Variable | Required | Purpose |
|---|---|---|
STARKFI_API_KEY |
Yes | Sent as x-api-key on every StarkFi request |
STARKFI_BASE_URL |
No | API base URL; default https://api.starkfi.io |
Example MCP host configuration (Cursor / Claude Desktop)
{
"mcpServers": {
"starkfi": {
"command": "npx",
"args": ["-y", "starkfi-mcp"],
"env": {
"STARKFI_API_KEY": "your_key_here"
}
}
}
}References: GitHub — starkfi-mcp-agent · npm — starkfi-mcp
Best for: plain HTTP clients, custom LLM stacks, or RAG where MCP is not in scope.
| Resource | URL |
|---|---|
| Product & API documentation | docs.starkfi.io |
| Structured index for models | docs.starkfi.io/llms.txt |
Tools are grouped by prefix; each tool’s MCP description guides when the model should invoke it.
| Prefix | Coverage |
|---|---|
yield_* |
Strategies, rebalance, earnings, deposit / withdraw / rebalance builds, broadcast |
order_* |
Order templates: list, retrieve, create, partial update, active toggle |
starkpay_* |
Payment status, intents, transaction creation, on-chain broadcast, card tokenization payloads |
kyc_* |
Prepare user, email OTP, verify OTP, Didit session, status |
Official SKILL.md bundles teach the agent yield, StarkPay / orders, KYC, and MCP host conventions. They ship with starkfi-agent-skills. Install into .cursor/skills/ so Cursor discovers them automatically.
Treat
STARKFI_API_KEYas a production secret. Store it in the MCP hostenvblock, a secure environment, or a secret manager—not in source control.
| Repository | Responsibility |
|---|---|
| starkfi-agent-skills | One-shot developer setup: Cursor skills + MCP registration |
| starkfi-mcp-agent | starkfi-mcp implementation and tool schemas |
| Goal | Command or link |
|---|---|
| Fastest Cursor / Claude onboarding | npx starkfi-agent-skills setup |
| Run MCP server standalone | STARKFI_API_KEY=… npx -y starkfi-mcp |
| Read-only grounding for LLMs | llms.txt |
| Protocol specification | Model Context Protocol |
StarkFi · Website & dashboard · Documentation