> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bullring.finance/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Bullring agent tools

> Install the Bullring Partner API skill in your AI coding harness.

Download the installable [`skill.md`](https://docs.bullring.finance/skill.md), or use the open agent-skills CLI.

The skill is documentation-only. It does not contain credentials, call the Bullring API, or grant an agent access to your account.

## Requirements

* Node.js with `npx`.
* An installed AI coding harness.
* A Bullring Partner API integration if the agent will implement or test requests.
* The RSA private key available to your application through a secret manager; never put it in the skill directory.

## Recommended installation

```bash theme={null}
npx skills add https://docs.bullring.finance/skill.md --yes
```

Install globally for a specific harness:

```bash OpenCode theme={null}
npx skills add https://docs.bullring.finance/skill.md --agent opencode --global --yes
```

```bash Claude Code theme={null}
npx skills add https://docs.bullring.finance/skill.md --agent claude-code --global --yes
```

```bash Codex theme={null}
npx skills add https://docs.bullring.finance/skill.md --agent codex --global --yes
```

```bash Cursor theme={null}
npx skills add https://docs.bullring.finance/skill.md --agent cursor --global --yes
```

```bash Windsurf theme={null}
npx skills add https://docs.bullring.finance/skill.md --agent windsurf --global --yes
```

```bash GitHub Copilot theme={null}
npx skills add https://docs.bullring.finance/skill.md --agent github-copilot --global --yes
```

Remove `--global` to install into the current project. Restart the harness after installation.

Install into several harnesses at once:

```bash theme={null}
npx skills add https://docs.bullring.finance/skill.md \
  --agent opencode \
  --agent claude-code \
  --agent codex \
  --agent cursor \
  --agent windsurf \
  --yes
```

## Installation scope

| Scope | Use when | Command change |
| - | - | - |
| Project-local | The skill should be committed or shared with one repository | Omit `--global` |
| Global | The skill should be available across your projects | Include `--global` |

Use project-local installation for a team integration repository. Review the downloaded file before committing it.

## OpenCode manual installation

```bash theme={null}
mkdir -p .opencode/skills/bullring-partner-api
curl -fsSL https://docs.bullring.finance/skill.md \
  -o .opencode/skills/bullring-partner-api/SKILL.md
```

For a global installation, use:

```bash theme={null}
mkdir -p ~/.config/opencode/skills/bullring-partner-api
curl -fsSL https://docs.bullring.finance/skill.md \
  -o ~/.config/opencode/skills/bullring-partner-api/SKILL.md
```

Restart OpenCode after installation. It should discover the skill under the `bullring-partner-api` ID. Ask OpenCode to use that skill before implementing an integration.

## Claude Code manual installation

Project-local:

```bash theme={null}
mkdir -p .claude/skills/bullring-partner-api
curl -fsSL https://docs.bullring.finance/skill.md \
  -o .claude/skills/bullring-partner-api/SKILL.md
```

Global:

```bash theme={null}
mkdir -p ~/.claude/skills/bullring-partner-api
curl -fsSL https://docs.bullring.finance/skill.md \
  -o ~/.claude/skills/bullring-partner-api/SKILL.md
```

Restart Claude Code and invoke the skill by asking it to use `bullring-partner-api`.

## Codex manual installation

Project-local:

```bash theme={null}
mkdir -p .agents/skills/bullring-partner-api
curl -fsSL https://docs.bullring.finance/skill.md \
  -o .agents/skills/bullring-partner-api/SKILL.md
```

Global:

```bash theme={null}
mkdir -p ~/.agents/skills/bullring-partner-api
curl -fsSL https://docs.bullring.finance/skill.md \
  -o ~/.agents/skills/bullring-partner-api/SKILL.md
```

Restart Codex after installation and ask it to use the Bullring Partner API skill.

## Cursor, Windsurf, and GitHub Copilot

Prefer the skills CLI because it places the skill in each harness’s native discovery directory. If manual installation is required, use the harness’s documented project skill directory and preserve this structure:

```text theme={null}
<harness-skill-directory>/bullring-partner-api/SKILL.md
```

Do not rename `SKILL.md`, flatten the folder, or paste private credentials into the file.

## Verify installation

After restarting the harness, use a prompt such as:

```text theme={null}
Confirm that the bullring-partner-api skill is installed. Summarize its supported endpoints, signing algorithm, webhook verification algorithm, and safety constraints without requesting any credentials.
```

The agent should identify:

* RSA-SHA256 / PKCS#1 v1.5 request signing.
* NGN institutions and account validation.
* Deposits, recipients, withdrawals, and conversion quotes.
* Convoy `X-BULLRING-SIGNATURE` HMAC verification.
* The rule never to expose private keys or webhook secrets.

## Update

```bash theme={null}
npx skills update
```

To refresh only this source, reinstall it:

```bash theme={null}
npx skills add https://docs.bullring.finance/skill.md --yes
```

For manual installations, download `skill.md` again and replace the existing `SKILL.md`. Review the [documentation references](https://docs.bullring.finance/ai-skills/references.md) after an update.

## MCP alternative

You can provide the documentation without installing the skill by connecting an MCP-compatible harness to:

```text theme={null}
https://docs.bullring.finance/mcp
```

See [Connect via MCP](https://docs.bullring.finance/ai-skills/mcp.md). MCP provides searchable documentation context; the installable skill provides a portable integration playbook.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.