@kasarlabs/cairo-coder-mcp 0.1.0 → 0.1.1

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 +40 -10
  2. package/dist/index.js +1 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  <div align="center">
2
2
  <img src="./cairo-grey.png" alt="Cairo Coder MCP Logo" width="300"/>
3
3
 
4
- [![npm version](https://img.shields.io/npm/v/@kasarlabs/cairo-coder-api.svg)](https://www.npmjs.com/package/@kasarlabs/cairo-coder-api)
5
- [![npm downloads](https://img.shields.io/npm/dm/@kasarlabs/cairo-coder-api.svg)](https://www.npmjs.com/package/@kasarlabs/cairo-coder-api)
4
+ [![npm version](https://img.shields.io/npm/v/@kasarlabs/cairo-coder-mcp.svg)](https://www.npmjs.com/package/@kasarlabs/cairo-coder-mcp)
5
+ [![npm downloads](https://img.shields.io/npm/dm/@kasarlabs/cairo-coder-mcp.svg)](https://www.npmjs.com/package/@kasarlabs/cairo-coder-mcp)
6
6
  [![GitHub stars](https://img.shields.io/github/stars/kasarlabs/cairo-coder-mcp.svg)](https://github.com/kasarlabs/cairo-coder-mcp/stargazers)
7
7
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
8
  </div>
@@ -16,25 +16,29 @@ A Model Context Protocol (MCP) server for Cairo and Starknet development assista
16
16
  Use this MCP server directly with npx:
17
17
 
18
18
  ```bash
19
- npx -y @kasarlabs/cairo-coder-api
19
+ npx -y @kasarlabs/cairo-coder-mcp
20
20
  ```
21
21
 
22
22
  ## Configuration
23
23
 
24
- ### Environment Variables
24
+ The server supports two modes of operation:
25
25
 
26
- - `CAIRO_CODER_API_KEY`: Your Cairo Coder API key (required)
26
+ ### Mode 1: Public Cairo Coder API (Default)
27
+
28
+ Use the official Cairo Coder API with your API key.
29
+
30
+ **Environment Variables:**
27
31
 
28
- ### Claude Desktop Setup
32
+ - `CAIRO_CODER_API_KEY`: Your Cairo Coder API key (required)
29
33
 
30
- Add this configuration to your `claude_desktop_config.json`:
34
+ **MCP Client Setup:**
31
35
 
32
36
  ```json
33
37
  {
34
38
  "mcpServers": {
35
39
  "cairo-coder": {
36
40
  "command": "npx",
37
- "args": ["-y", "@kasarlabs/cairo-coder-api"],
41
+ "args": ["-y", "@kasarlabs/cairo-coder-mcp"],
38
42
  "env": {
39
43
  "CAIRO_CODER_API_KEY": "your-api-key-here"
40
44
  }
@@ -43,6 +47,32 @@ Add this configuration to your `claude_desktop_config.json`:
43
47
  }
44
48
  ```
45
49
 
50
+ ### Mode 2: Local/Custom Endpoint
51
+
52
+ Use a local or custom Cairo Coder API endpoint (no API key required).
53
+
54
+ **Environment Variables:**
55
+
56
+ - `CAIRO_CODER_API_ENDPOINT`: Your local endpoint URL (e.g., "http://localhost:8000")
57
+
58
+ **MCP Client Setup:**
59
+
60
+ ```json
61
+ {
62
+ "mcpServers": {
63
+ "cairo-coder": {
64
+ "command": "npx",
65
+ "args": ["-y", "@kasarlabs/cairo-coder-mcp"],
66
+ "env": {
67
+ "CAIRO_CODER_API_ENDPOINT": "http://localhost:8000"
68
+ }
69
+ }
70
+ }
71
+ }
72
+ ```
73
+
74
+ > **Note:** When using `CAIRO_CODER_API_ENDPOINT`, the server automatically switches to local mode and no API key is required or used.
75
+
46
76
  ## Available Tools
47
77
 
48
78
  ### assist_with_cairo
@@ -94,7 +124,7 @@ Get help with Cairo and Starknet development tasks.
94
124
 
95
125
  ```bash
96
126
  git clone <repository-url>
97
- cd cairo-coder-api
127
+ cd cairo-coder-mcp
98
128
  npm install
99
129
  ```
100
130
 
@@ -114,7 +144,7 @@ MIT
114
144
 
115
145
  For issues and questions:
116
146
 
117
- - GitHub Issues: [Create an issue](https://github.com/kasarlabs/cairo-coder-api/issues)
147
+ - GitHub Issues: [Create an issue](https://github.com/kasarlabs/cairo-coder-mcp/issues)
118
148
  - MCP Documentation: [Model Context Protocol](https://modelcontextprotocol.io/)
119
149
 
120
150
  ## Contributing
package/dist/index.js CHANGED
@@ -19,7 +19,7 @@ class CairoCoderMCPServer {
19
19
  */
20
20
  constructor() {
21
21
  this.server = new Server({
22
- name: "cairo-coder-api",
22
+ name: "cairo-coder-mcp",
23
23
  version: "1.0.0",
24
24
  capabilities: {
25
25
  tools: {},
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kasarlabs/cairo-coder-mcp",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "MCP server to interact with the Cairo Coder API",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -11,7 +11,7 @@
11
11
  }
12
12
  },
13
13
  "bin": {
14
- "cairo-coder-api": "./dist/index.js"
14
+ "cairo-coder-mcp": "./dist/index.js"
15
15
  },
16
16
  "files": [
17
17
  "dist",