Starknet Specifications

https://github.com/starkware-libs/starknet-specs
Admin
Starknet Specifications provides technical specifications and tooling for OpenRPC files, pertaining...
Tokens:4,598
Snippets:83
Trust Score:9.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Python Dependencies for MCP Server

Source: https://github.com/starkware-libs/starknet-specs/blob/master/mcp/README.md

Installs the necessary Python dependencies for the Starknet MCP server. This is a prerequisite for manual setup.

```bash
pip install -r mcp/requirements.txt
```

--------------------------------

### Install Starknet MCP with Claude Code

Source: https://github.com/starkware-libs/starknet-specs/blob/master/mcp/README.md

Use this command to install dependencies and automatically register the Starknet MCP server with Claude Code. Replace <your-rpc-url> with your Starknet JSON-RPC endpoint.

```bash
/install-starknet-mcp <your-rpc-url>
```

--------------------------------

### Validate Starknet OpenRPC Schema

Source: https://github.com/starkware-libs/starknet-specs/blob/master/README.md

Run this script to validate the OpenRPC schema file for the Starknet API. Ensure Node.js is installed.

```shell
./validate.js api/starknet_api_openrpc.json
```

--------------------------------

### Register MCP Server Project-Only

Source: https://github.com/starkware-libs/starknet-specs/blob/master/mcp/README.md

Registers the MCP server for project-only scope, making it available only within the current repository. Ensure you replace <your-rpc-url> with your Starknet JSON-RPC endpoint.

```bash
claude mcp add --env STARKNET_RPC_URL=<your-rpc-url> starknet -- python mcp/server.py
```

--------------------------------

### Register MCP Server Globally

Source: https://github.com/starkware-libs/starknet-specs/blob/master/mcp/README.md

Registers the MCP server globally for use across all projects. This is recommended for frequent Starknet development. Replace <your-rpc-url> with your Starknet JSON-RPC endpoint and adjust the path if necessary.

```bash
claude mcp add --scope user --env STARKNET_RPC_URL=<your-rpc-url> starknet -- python /absolute/path/to/mcp/server.py
```

--------------------------------

### Run Integration Tests for MCP Server

Source: https://github.com/starkware-libs/starknet-specs/blob/master/mcp/README.md

Executes integration tests for the Starknet MCP server that require a live RPC connection. Replace <your-rpc-url> with your Starknet JSON-RPC endpoint.

```bash
cd mcp
pip install -r requirements-dev.txt

# Integration tests (live RPC)
STARKNET_RPC_URL=<your-rpc-url> pytest tests/test_server.py -m integration -v
```

--------------------------------

### Run Unit Tests for MCP Server

Source: https://github.com/starkware-libs/starknet-specs/blob/master/mcp/README.md

Executes unit tests for the Starknet MCP server that do not require network calls. Ensure you set the STARKNET_RPC_URL environment variable, though it won't be used for these tests.

```bash
cd mcp
pip install -r requirements-dev.txt

# Unit tests (no network calls)
STARKNET_RPC_URL=http://unused pytest tests/test_server.py -m "not integration" -v
```

--------------------------------

### Update Package JSON Version

Source: https://github.com/starkware-libs/starknet-specs/blob/master/api/release.md

When updating the specification version, you also need to update the version in package.json files. This command handles that update without creating a Git tag.

```bash
npm version <VERSION> --no-git-tag-version
```
Tokens:
Raw