litcoin-mcp 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +25 -65
  2. package/package.json +1 -1
  3. package/src/index.js +46 -0
package/README.md CHANGED
@@ -1,88 +1,48 @@
1
1
  # LITCOIN MCP Server
2
2
 
3
- MCP server for the [LITCOIN](https://litcoiin.xyz) proof-of-comprehension protocol on Base. Gives any AI agent full protocol access through the Model Context Protocol.
3
+ MCP server for the LITCOIN protocol on Base. Mine, research, stake, vault, compute, guilds — all from any MCP-compatible AI agent. 25 tools, including 6 research tools.
4
4
 
5
- ## Setup
5
+ ## Install
6
6
 
7
- ### Claude Desktop / Claude Code
8
-
9
- Add to your MCP config (`claude_desktop_config.json` or `.claude.json`):
7
+ Add to your MCP config (Claude Desktop, Cursor, etc.):
10
8
 
11
9
  ```json
12
10
  {
13
11
  "mcpServers": {
14
12
  "litcoin": {
15
13
  "command": "npx",
16
- "args": ["-y", "litcoin-mcp"],
17
- "env": {
18
- "BANKR_API_KEY": "bk_YOUR_KEY"
19
- }
14
+ "args": ["litcoin-mcp"],
15
+ "env": { "BANKR_API_KEY": "bk_YOUR_KEY" }
20
16
  }
21
17
  }
22
18
  }
23
19
  ```
24
20
 
25
- ### Cursor
21
+ ## Tools (25)
26
22
 
27
- Add to `.cursor/mcp.json`:
23
+ **Mining**: mine, claim, claimable, faucet
24
+ **Balances**: balance, network
25
+ **Staking**: stake, unstake
26
+ **Vaults**: open_vault, mint, repay, add_collateral, close_vault, vaults
27
+ **Compute**: deposit_escrow, compute
28
+ **Guilds**: create_guild, join_guild, leave_guild
29
+ **Research**: research_tasks, research_get_task, research_submit, research_results, research_stats, research_history
28
30
 
29
- ```json
30
- {
31
- "mcpServers": {
32
- "litcoin": {
33
- "command": "npx",
34
- "args": ["-y", "litcoin-mcp"],
35
- "env": {
36
- "BANKR_API_KEY": "bk_YOUR_KEY"
37
- }
38
- }
39
- }
40
- }
41
- ```
31
+ ## Research Mining
42
32
 
43
- Get a Bankr API key at [bankr.bot/api](https://bankr.bot/api).
33
+ Agents can browse optimization tasks, submit solutions, and track their iteration history — all through natural language:
44
34
 
45
- ## Available Tools
35
+ > "Show me research tasks" → lists active tasks with baselines
36
+ > "Submit this sorting solution" → verifies and rewards if it beats baseline
37
+ > "Show my research history" → iteration progress per task
46
38
 
47
- | Tool | Description |
48
- |------|-------------|
49
- | `litcoin_balance` | Check LITCOIN, LITCREDIT, staking tier, mining boost, escrow balance |
50
- | `litcoin_network` | Network stats: active miners, treasury, rewards, oracle prices |
51
- | `litcoin_mine` | Mine one round (solve a comprehension challenge, earn LITCOIN) |
52
- | `litcoin_claim` | Claim accumulated mining rewards on-chain |
53
- | `litcoin_claimable` | Check how much is available to claim |
54
- | `litcoin_stake` | Stake into a tier (1=Spark, 2=Circuit, 3=Core, 4=Architect) |
55
- | `litcoin_unstake` | Unstake after lock period |
56
- | `litcoin_open_vault` | Open a vault with LITCOIN collateral |
57
- | `litcoin_mint` | Mint LITCREDIT against a vault |
58
- | `litcoin_repay` | Repay LITCREDIT debt |
59
- | `litcoin_add_collateral` | Add collateral to a vault |
60
- | `litcoin_close_vault` | Close a vault |
61
- | `litcoin_vaults` | List all vaults with health ratios |
62
- | `litcoin_deposit_escrow` | Deposit LITCREDIT for compute spending |
63
- | `litcoin_compute` | Send a prompt to the compute marketplace |
64
- | `litcoin_create_guild` | Create a mining guild |
65
- | `litcoin_join_guild` | Join a guild with deposit |
66
- | `litcoin_leave_guild` | Leave a guild |
67
- | `litcoin_faucet` | Claim 5M free LITCOIN (one-time bootstrap) |
68
-
69
- ## Example Conversation
39
+ ## Links
70
40
 
71
- > **You:** Check my LITCOIN balance
72
- >
73
- > **Agent:** *(calls litcoin_balance)* You have 3,200,000 LITCOIN and 0 LITCREDIT. You're not staked yet.
74
- >
75
- > **You:** Stake into Circuit tier
76
- >
77
- > **Agent:** *(calls litcoin_stake with tier=2)* Done! Staked 5M LITCOIN into Circuit tier. Mining boost: 1.25x.
78
- >
79
- > **You:** Mine 5 rounds
80
- >
81
- > **Agent:** *(calls litcoin_mine 5 times)* Mined 5 rounds. Earned 750,000 LITCOIN total.
41
+ - Site: https://litcoiin.xyz
42
+ - Research Lab: https://litcoiin.xyz/research
43
+ - SDK: `pip install litcoin`
44
+ - Docs: https://litcoiin.xyz/docs
82
45
 
83
- ## Links
46
+ ## License
84
47
 
85
- - [LITCOIN Website](https://litcoiin.xyz)
86
- - [Full Docs (AI-readable)](https://litcoiin.xyz/docs.md)
87
- - [SDK on PyPI](https://pypi.org/project/litcoin/)
88
- - [Twitter](https://x.com/litcoin_AI)
48
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "litcoin-mcp",
3
- "version": "2.0.0",
3
+ "version": "2.1.0",
4
4
  "description": "MCP server for the LITCOIN proof-of-comprehension protocol on Base. Mine, stake, vault, compute, research — all from any AI agent.",
5
5
  "main": "src/index.js",
6
6
  "bin": {
package/src/index.js CHANGED
@@ -668,6 +668,52 @@ server.tool(
668
668
  }
669
669
  );
670
670
 
671
+ server.tool(
672
+ "litcoin_miner_status",
673
+ "Get comprehensive miner status: mining activity, relay connection (connected/disconnected), quality score, requests served, earnings breakdown (comprehension/research/staking/relay), guild membership, and overall health check. Essential for debugging relay issues.",
674
+ {
675
+ wallet: z.string().optional().describe("Wallet to check (defaults to your wallet)"),
676
+ },
677
+ async ({ wallet }) => {
678
+ const w = wallet || await getWallet();
679
+ const data = await coordGet(`/v1/miner/status?wallet=${w}`);
680
+ return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
681
+ }
682
+ );
683
+
684
+ server.tool(
685
+ "litcoin_guild_yield",
686
+ "Get network-wide guild yield data: recent yield distribution history (24h chart data), per-member cumulative yields, total yield earned across all guilds. Shows how the 25% staking pool is distributed to guild members.",
687
+ {},
688
+ async () => {
689
+ const data = await coordGet("/v1/guilds/yield");
690
+ return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
691
+ }
692
+ );
693
+
694
+ server.tool(
695
+ "litcoin_guild_member_yield",
696
+ "Get your personal guild yield history: total yield earned, recent entries for charting, deposit amount, share percentage, and guild ID.",
697
+ {
698
+ wallet: z.string().optional().describe("Wallet to check (defaults to your wallet)"),
699
+ },
700
+ async ({ wallet }) => {
701
+ const w = wallet || await getWallet();
702
+ const data = await coordGet(`/v1/guilds/yield/${w}`);
703
+ return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
704
+ }
705
+ );
706
+
707
+ server.tool(
708
+ "litcoin_protocol_stats",
709
+ "Get cached protocol statistics: totalStaked, litcreditSupply, vaultCollateral, vaultDebt, cpiPrice, litcoinPrice, treasury balance. Updated every 120 seconds.",
710
+ {},
711
+ async () => {
712
+ const data = await coordGet("/v1/protocol/stats");
713
+ return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
714
+ }
715
+ );
716
+
671
717
  function solveChallenge(challenge) {
672
718
  const { doc, questions, constraints, entities } = challenge;
673
719
  if (!doc || !questions) return "";