npm package: @kasarlabs/noir-coder-mcp
Description: MCP server to interact with the Noir Coder API
Author: KasarLabs
Latest version: 0.1.1

<div align="center">
  [![npm version](https://img.shields.io/npm/v/@kasarlabs/noir-coder-mcp.svg)](https://www.npmjs.com/package/@kasarlabs/noir-coder-mcp)
  [![npm downloads](https://img.shields.io/npm/dm/@kasarlabs/noir-coder-mcp.svg)](https://www.npmjs.com/package/@kasarlabs/noir-coder-mcp)
  [![GitHub stars](https://img.shields.io/github/stars/kasarlabs/noir-coder-mcp.svg)](https://github.com/kasarlabs/noir-coder-mcp/stargazers)
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
</div>

# Noir Coder MCP Server

A Model Context Protocol (MCP) server for Noir and zero-knowledge proof development assistance via the Noir Coder API.

## Quick Start

Use this MCP server directly with npx:

```bash
npx -y @kasarlabs/noir-coder-mcp
```

## Configuration

The server connects to the Noir Coder API endpoint. No API key is required.

**MCP Client Setup:**

```json
{
  "mcpServers": {
    "noir-coder": {
      "command": "npx",
      "args": ["-y", "@kasarlabs/noir-coder-mcp"]
    }
  }
}
```

## Available Tools

### assist_with_noir

Get help with Noir and zero-knowledge proof development tasks.

**Parameters:**

- `query` (string, required): Your Noir/zero-knowledge proof development question
- `codeSnippets` (array of strings, optional): Additional code snippets for context
- `history` (array of strings, optional): Conversation history for context

**Examples:**

```typescript
// Simple request
{
  "query": "Write a simple Noir circuit that proves knowledge of a secret number"
}

// With code snippets
{
  "query": "How can I optimize this circuit?",
  "codeSnippets": ["fn main(private_input: Field, public_input: pub Field) {\n    assert(private_input * private_input == public_input);\n}"]
}
```

## What You Can Do

- **Write Noir code**: Generate zero-knowledge proof circuits and Noir code
- **Refactor code**: Improve and optimize existing circuits
- **Implement features**: Complete TODOs and implement specific functionality
- **Learn Noir**: Get contextual information about the Noir ecosystem
- **Best practices**: Receive advice based on Noir/zero-knowledge proof documentation

## Tips for Better Results

- Use specific queries (e.g., "Creating a circuit to prove knowledge of a secret" instead of just "Noir circuit")
- Include relevant code snippets when working with existing circuits
- Provide necessary context for more accurate responses

## Development

### Prerequisites

- Node.js >= 18
- npm or yarn

### Local Installation

```bash
git clone <repository-url>
cd noir-coder-mcp
npm install
```

### Available Scripts

```bash
npm run build    # Build the project
npm run dev      # Start in development mode
npm start        # Start in production mode
```

## License

MIT

## Support

For issues and questions:

- GitHub Issues: [Create an issue](https://github.com/kasarlabs/noir-coder-mcp/issues)
- MCP Documentation: [Model Context Protocol](https://modelcontextprotocol.io/)

## Contributing

Contributions are welcome! Please check the contribution guidelines before submitting a PR.