npm @tryrival/regulatory-toolkitstdioApache-2.0updated 2mo ago
Open-source SDK, CLI, MCP server, and schemas for connecting AI agents to Rival's source-grounded regulatory retrieval API.
Rival Regulatory Toolkit 能做什么?
Rival Regulatory Toolkit
Open-source SDK, CLI, MCP server, and schemas for connecting AI agents to Rival's source-grounded regulatory retrieval API.
- Public site: https://tryrival.ai
- Agent access: https://tryrival.ai/for-agents
- Managed API default:
https://api.tryrival.ai
This repository is the developer and agent connectivity layer for Rival. It is intentionally read-only in its first release: agents can search, retrieve source text, trace citations, list authorities, and inspect recent filings. Workspace actions, document review, evidence requests, filings, and task creation remain behind managed Rival access and human review gates.
What Is Included
- OpenAPI contract for Rival's read-only regulatory retrieval API.
- JSON Schemas for source documents, search results, citations, authorities, and recent filings.
- TypeScript client for server-side applications and internal tools.
- CLI for shell usage and automation.
- MCP server for agent clients that support Model Context Protocol.
- Fixture mode so teams can evaluate the integration without a Rival API key.
- Dockerfile for running the MCP server in controlled team environments.
Install
npm install @rival-intelligence/regulatory-toolkit
For local development from source:
npm install
npm run build
Environment
export RIVAL_API_KEY="rv_live_..."
export RIVAL_API_BASE_URL="https://api.tryrival.ai"
For local evaluation without API access:
export RIVAL_FIXTURE_MODE=true
TypeScript Client
import { RivalRegulatoryClient } from '@rival-intelligence/regulatory-toolkit';
const rival = new RivalRegulatoryClient({
apiKey: process.env.RIVAL_API_KEY,
});
const results = await rival.searchRegulatoryCorpus({
query: '49 CFR 195.573',
limit: 5,
});
console.log(results.results[0]?.source.citation);
CLI
rival-regulatory search "49 CFR 195.573"
rival-regulatory source "cfr-49-195-573"
rival-regulatory trace "49 CFR 195.573"
rival-regulatory authorities
Fixture mode:
rival-regulatory search "pipeline corrosion" --fixture
MCP Server
Run directly:
npx @rival-intelligence/regulatory-toolkit mcp
MCP client example:
{
"mcpServers": {
"rival-regulatory": {
"command": "npx",
"args": ["-y", "@rival-intelligence/regulatory-toolkit", "mcp"],
"env": {
"RIVAL_API_KEY": "rv_live_...",
"RIVAL_API_BASE_URL": "https://api.tryrival.ai"
}
}
}
}
Available MCP tools:
search_regulatory_corpusretrieve_source_texttrace_citationlist_authoritiesget_recent_filings
Docker
Docker belongs in this repository because many compliance, legal, consulting, energy, and infrastructure teams will run agent tools inside controlled environments. The image runs the MCP server and reads credentials from environment variables.
docker build -t rival-regulatory-toolkit .
docker run --rm -i \
-e RIVAL_API_KEY="$RIVAL_API_KEY" \
-e RIVAL_API_BASE_URL="https://api.tryrival.ai" \
rival-regulatory-toolkit
Fixture mode:
docker run --rm -i -e RIVAL_FIXTURE_MODE=true rival-regulatory-toolkit
See docs/self-hosting.md for deployment notes.
API Contract
The API contract starts with five read-only endpoints:
GET /api/v1/searchGET /api/v1/sources/{source_id}GET /api/v1/citations/traceGET /api/v1/authoritiesGET /api/v1/filings/recent
The contract lives in openapi/rival-regulatory-api.yaml.
Safety Boundary
This toolkit does not submit filings, alter compliance records, close corrective actions, delete evidence, or take workspace actions. It is a source retrieval and citation layer for agents and developer systems. Regulated work still requires qualified human review.
This toolkit is not legal, engineering, environmental, safety, or compliance advice. Teams are responsible for validating applicability, obligations, filings, and operational decisions with qualified professionals.
Development
npm install
npm run build
npm test
License
Apache-2.0
安装
把 Rival Regulatory Toolkit 添加到你的客户端。选择你正在使用的那个。
claude mcp add regulatory-toolkit -- npx -y @tryrival/regulatory-toolkitcodex mcp add regulatory-toolkit -- npx -y @tryrival/regulatory-toolkitamp mcp add regulatory-toolkit -- npx -y @tryrival/regulatory-toolkit{
"mcpServers": {
"regulatory-toolkit": {
"command": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
]
}
}
}Add to `claude_desktop_config.json`, then restart Claude Desktop.
{
"mcpServers": {
"regulatory-toolkit": {
"command": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
]
}
}
}Add to `~/.cursor/mcp.json`, or `.cursor/mcp.json` for a single project.
code --add-mcp '{"name":"regulatory-toolkit","command":"npx","args":["-y","@tryrival/regulatory-toolkit"]}'Or add the block manually to `.vscode/mcp.json` under `servers`.
{
"mcpServers": {
"regulatory-toolkit": {
"command": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
]
}
}
}Add to `~/.codeium/windsurf/mcp_config.json`.
{
"mcpServers": {
"regulatory-toolkit": {
"command": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
]
}
}
}Add to `cline_mcp_settings.json` via the MCP Servers panel.
{
"mcpServers": {
"regulatory-toolkit": {
"command": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
]
}
}
}Add to `~/.gemini/settings.json`.
{
"mcpServers": {
"regulatory-toolkit": {
"type": "local",
"command": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
],
"tools": [
"*"
]
}
}
}Add to `~/.copilot/mcp-config.json`, or run `/mcp add` inside the CLI.
{
"context_servers": {
"regulatory-toolkit": {
"command": {
"path": "npx",
"args": [
"-y",
"@tryrival/regulatory-toolkit"
]
}
}
}
}Add to your Zed `settings.json`.
npx -y @tryrival/regulatory-toolkitRun `goose configure`, choose **Add Extension → Command-line Extension**, and paste this command.
评分
39 / 100
不完整
- 文档25/25
- 维护16/25
- 可信度16/20
- 能力0/15
- 安装体验12/15
- Documents what it does and how to connect
- Has a resolvable package or endpoint
- Exposes at least one tool, prompt or resource
- README has substantive content
- Includes a code example
- Documents its configuration
- Mentions credentials or security posture
- Last commit 53 days ago
- Has a release history
- Repository is not archived
- Licensed Apache-2.0
- Namespace verified in the official MCP registry
- Claimed by its owner
- Published under an organisation
- 0 tool(s) documented
- Provides prompt templates
- Provides resources
- 12 documented install method(s)
- Published to a package registry
- Offers a hosted endpoint — no local install
版本历史
| 版本 | 发布于 |
|---|---|
| 0.1.5最新 | 2026年5月19日 |