Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
commitlint:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
- name: Lint commits
run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
- run: npm test
- run: npm run build

release:
needs: test
runs-on: ubuntu-latest
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
permissions:
contents: write
issues: write
pull-requests: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
registry-url: https://registry.npmjs.org
- run: npm ci
- run: npm run build
- name: Release
run: npx semantic-release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
9 changes: 9 additions & 0 deletions .releaserc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"branches": ["main"],
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/npm",
"@semantic-release/github"
]
}
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ An MCP (Model Context Protocol) server that provides local access to Aztec docum
### With npx (recommended)

```bash
npx aztec-mcp-server
npx @aztec/mcp-server
```

### Global install

```bash
npm install -g aztec-mcp-server
npm install -g @aztec/mcp-server
aztec-mcp
```

Expand All @@ -36,7 +36,7 @@ Add to your `.mcp.json`:
"mcpServers": {
"aztec-local": {
"command": "npx",
"args": ["-y", "aztec-mcp-server@latest"]
"args": ["-y", "@aztec/mcp-server@latest"]
}
}
}
Expand Down Expand Up @@ -135,7 +135,7 @@ Override with the `AZTEC_MCP_REPOS_DIR` environment variable:
"mcpServers": {
"aztec-local": {
"command": "npx",
"args": ["-y", "aztec-mcp-server"],
"args": ["-y", "@aztec/mcp-server"],
"env": {
"AZTEC_MCP_REPOS_DIR": "/custom/path"
}
Expand All @@ -153,7 +153,7 @@ Set the default Aztec version with the `AZTEC_DEFAULT_VERSION` environment varia
"mcpServers": {
"aztec-local": {
"command": "npx",
"args": ["-y", "aztec-mcp-server"],
"args": ["-y", "@aztec/mcp-server"],
"env": {
"AZTEC_DEFAULT_VERSION": "v3.0.0-devnet.6-plugin.1"
}
Expand All @@ -166,8 +166,8 @@ Set the default Aztec version with the `AZTEC_DEFAULT_VERSION` environment varia

```bash
# Clone the repo
git clone https://github.com/critesjosh/aztec-mcp-server
cd aztec-mcp-server
git clone https://github.com/aztecprotocol/mcp-server
cd mcp-server

# Install dependencies
npm install
Expand Down
1 change: 1 addition & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export default { extends: ['@commitlint/config-conventional'] };
Loading