# Install charity

These examples use published, verified artifacts. Keep signing keys on your server.

<span id="install-tab-script"></span><span id="install-panel-script"></span>

## Script tag

The relay is a route on your server. It signs calls as your registered app.

```html
<script src="https://cdn.comms.id/charity/1.1.0.js" integrity="sha384-pX9D5EsDbTrVkyh8oa3tWEINa39+kzTQ6QQPAqnGPGmEIAqrDNExvq8KWA7HtHLv" crossorigin="anonymous"></script>
<comms-id-charity relay="/api/comms-id/charity"></comms-id-charity>
```

<span id="install-tab-react"></span><span id="install-panel-react"></span>

## React

```sh
pnpm add @comms-id/charity-react@0.2.2 @comms-id/charity@0.4.1
```

```tsx
import { createCharityBrowserClient } from "@comms-id/charity/browser";
import { CharityLookup } from "@comms-id/charity-react";

const client = createCharityBrowserClient({ relayUrl: "/api/comms-id/charity" });
export const Example = () => <CharityLookup client={client} />;
```

<span id="install-tab-sdk"></span><span id="install-panel-sdk"></span>

## Server SDK

```sh
pnpm add @comms-id/charity@0.4.1
```

```ts
import { createCharityClient } from "@comms-id/charity/server";
const client = createCharityClient({
  clientId: process.env.COMMS_ID_CLIENT_ID!,
  privateJwk: JSON.parse(process.env.COMMS_ID_PRIVATE_JWK!),
});
```

See the operation reference for request, response and command-line examples.

<span id="install-tab-relay"></span><span id="install-panel-relay"></span>

## Relay

Install the server relay into your relying-party app:

```sh
pnpm dlx comms-id add charity-relay
```

<span id="install-tab-api"></span><span id="install-panel-api"></span>

## Agent tools

Product tools are served at https://mcp.comms.id. The documentation MCP serves
documentation only; it does not execute product operations.

## Operations

### lookup

[Read the lookup API reference](/docs/reference/charity/charity/charity-lookup).

## Upgrading

[Upgrade guide](/docs/reference/charity/upgrade).
