Install charity

Install charity

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

Script tag

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

<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>

React

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

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} />;

Server SDK

pnpm add @comms-id/charity@0.4.1

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.

Relay

Install the server relay into your relying-party app:

pnpm dlx comms-id add charity-relay

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.

Upgrading

Upgrade guide.