From a1deee92ccbfbb6c1f45796055c2b640e1f0f495 Mon Sep 17 00:00:00 2001 From: Jeffrey von Rotz Date: Sat, 21 Feb 2026 05:05:54 +0100 Subject: [PATCH] docs: expand README to gold standard --- README.md | 407 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 301 insertions(+), 106 deletions(-) diff --git a/README.md b/README.md index a837384..44360e4 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,86 @@ -# Israel Law MCP +# Israeli Law MCP Server -[![npm](https://img.shields.io/npm/v/@ansvar/israel-law-mcp)](https://www.npmjs.com/package/@ansvar/israel-law-mcp) -[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE) -[![CI](https://github.com/Ansvar-Systems/israel-law-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Ansvar-Systems/israel-law-mcp/actions/workflows/ci.yml) -[![MCP Registry](https://img.shields.io/badge/MCP-Registry-green)](https://registry.modelcontextprotocol.io/) -[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/Ansvar-Systems/israel-law-mcp)](https://securityscorecards.dev/viewer/?uri=github.com/Ansvar-Systems/israel-law-mcp) +**The Knesset alternative for the AI age.** -A Model Context Protocol (MCP) server providing comprehensive access to Israeli legislation, including the Privacy Protection Law, Protection of Privacy Regulations (Data Security), Computer Law, Companies Law, Electronic Signature Law, and Credit Data Law with full-text search. +[![npm version](https://badge.fury.io/js/%40ansvar/israel-law-mcp.svg)](https://www.npmjs.com/package/@ansvar/israel-law-mcp) +[![MCP Registry](https://img.shields.io/badge/MCP-Registry-blue)](https://registry.modelcontextprotocol.io) +[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![GitHub stars](https://img.shields.io/github/stars/Ansvar-Systems/Israel-law-mcp?style=social)](https://github.com/Ansvar-Systems/Israel-law-mcp) +[![CI](https://github.com/Ansvar-Systems/Israel-law-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/Ansvar-Systems/Israel-law-mcp/actions/workflows/ci.yml) -## Deployment Tier +Query **Israeli legislation** -- covering data protection, cybersecurity, corporate law, and more -- directly from Claude, Cursor, or any MCP-compatible client. -**SMALL** -- Single tier, bundled SQLite database shipped with the npm package. +If you're building legal tech, compliance tools, or doing Israeli legal research, this is your verified reference database. -**Estimated database size:** ~60-120 MB (full corpus of Israeli federal legislation with English translations) +Built by [Ansvar Systems](https://ansvar.eu) -- Stockholm, Sweden -## Key Legislation Covered +--- -| Law | Year | Significance | -|-----|------|-------------| -| **Privacy Protection Law** | 1981 (amended) | Comprehensive privacy law; predates GDPR; Israel has EU adequacy decision; database registration regime | -| **Protection of Privacy Regulations (Data Security)** | 2017 | Specific technical and organisational security requirements for database owners; four security levels | -| **Computer Law** | 1995 | Criminalises unauthorised computer access, interference, and computer viruses | -| **Companies Law** | 1999 | Corporate governance, registration, directors' duties, and corporate obligations | -| **Electronic Signature Law** | 2001 | Legal recognition of electronic signatures and certification authorities | -| **Credit Data Law** | 2002 | Regulation of credit data collection, processing, and sharing | -| **Basic Law: Human Dignity and Liberty** | 1992 | Quasi-constitutional protection of human dignity and liberty including privacy | +## Why This Exists -## Regulatory Context +Israeli legal research is scattered across official government databases, commercial legal platforms, and institutional archives. Whether you're: +- A **lawyer** validating citations in a brief or contract +- A **compliance officer** checking if a statute is still in force +- A **legal tech developer** building tools on Israeli law +- A **researcher** tracing legislative history -- **Data Protection Supervisory Authority:** Privacy Protection Authority (PPA), operating under the Ministry of Justice -- **Israel has an EU adequacy decision** under the Data Protection Directive, maintained under GDPR review, recognising Israel's data protection framework as providing adequate safeguards for data transfers from the EU -- **The Privacy Protection Law (1981)** established one of the earliest comprehensive data protection frameworks globally; it is being modernised to align more closely with GDPR -- **Protection of Privacy Regulations (Data Security) 2017** impose specific technical requirements at four security levels based on database sensitivity and size -- Israel is a **major global cybersecurity hub** (Unit 8200, extensive startup ecosystem), making its legal framework highly relevant to cybersecurity clients -- Israel uses a mixed legal system combining elements of common law, civil law, and religious law -- Hebrew is the legally binding language; English translations are available for major laws but are unofficial -- The Knesset (parliament) database and Nevo commercial database are the primary legal information sources +...you shouldn't need dozens of browser tabs and manual PDF cross-referencing. Ask Claude. Get the exact provision. With context. -## Data Sources +This MCP server makes Israeli law **searchable, cross-referenceable, and AI-readable**. -| Source | Authority | Method | Update Frequency | License | Coverage | -|--------|-----------|--------|-----------------|---------|----------| -| [Knesset Legislation Database](https://main.knesset.gov.il/Activity/Legislation) | The Knesset | HTML Scrape | Weekly | Government Open Data | All primary legislation, Basic Laws, bills | -| [Nevo Legal Database](https://www.nevo.co.il) | Nevo (commercial) | HTML Scrape | Daily | Commercial (public law content) | Comprehensive legislation, regulations, court decisions | -| [Israeli Law Resource Center](https://www.gov.il/en/departments/legalinfo) | Government of Israel | HTML Scrape | Monthly | Government Publication | English translations of major laws | +--- -> Full provenance metadata: [`sources.yml`](./sources.yml) +## Quick Start -## Installation +### Use Remotely (No Install Needed) -```bash -npm install -g @ansvar/israel-law-mcp +> Connect directly to the hosted version -- zero dependencies, nothing to install. + +**Endpoint:** `https://israel-law-mcp.vercel.app/mcp` + +| Client | How to Connect | +|--------|---------------| +| **Claude.ai** | Settings > Connectors > Add Integration > paste URL | +| **Claude Code** | `claude mcp add israel-law --transport http https://israel-law-mcp.vercel.app/mcp` | +| **Claude Desktop** | Add to config (see below) | +| **GitHub Copilot** | Add to VS Code settings (see below) | + +**Claude Desktop** -- add to `claude_desktop_config.json`: + +```json +{ + "mcpServers": { + "israel-law": { + "type": "url", + "url": "https://israel-law-mcp.vercel.app/mcp" + } + } +} ``` -## Usage +**GitHub Copilot** -- add to VS Code `settings.json`: -### As stdio MCP server - -```bash -israel-law-mcp +```json +{ + "github.copilot.chat.mcp.servers": { + "israel-law": { + "type": "http", + "url": "https://israel-law-mcp.vercel.app/mcp" + } + } +} ``` -### In Claude Desktop / MCP client configuration +### Use Locally (npm) + +```bash +npx @ansvar/israel-law-mcp +``` + +**Claude Desktop** -- add to `claude_desktop_config.json`: + +**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json` +**Windows:** `%APPDATA%\Claude\claude_desktop_config.json` ```json { @@ -74,69 +93,245 @@ israel-law-mcp } ``` -## Available Tools +**Cursor / VS Code:** -| Tool | Description | -|------|-------------| -| `get_provision` | Retrieve a specific section/article from an Israeli law | -| `search_legislation` | Full-text search across all Israeli legislation | -| `get_provision_eu_basis` | Cross-reference lookup for international framework relationships (GDPR adequacy, etc.) | - -## Development - -```bash -# Install dependencies -npm install - -# Build -npm run build - -# Run tests -npm test - -# Run contract tests -npm run test:contract - -# Run all validation -npm run validate - -# Build database from sources -npm run build:db - -# Start server -npm start +```json +{ + "mcp.servers": { + "israel-law": { + "command": "npx", + "args": ["-y", "@ansvar/israel-law-mcp"] + } + } +} ``` -## Contract Tests - -This MCP includes 12 golden contract tests covering: -- 3 article retrieval tests (Privacy Protection Law, Companies Law) -- 3 search tests (privacy, data security, computer) -- 2 citation roundtrip tests (official knesset.gov.il/nevo.co.il URL patterns) -- 2 cross-reference tests (GDPR adequacy, data security standards) -- 2 negative tests (non-existent law, malformed section) - -Run with: `npm run test:contract` - -## EU Adequacy Decision - -Israel is one of the few non-EU countries with an EU adequacy decision for data protection. This means: -- Personal data can flow freely from the EU/EEA to Israel without additional safeguards -- The Privacy Protection Law and its regulations are considered to provide an adequate level of data protection -- The adequacy decision is subject to periodic review by the European Commission - -This makes Israel Law MCP particularly relevant for organisations operating across EU-Israel data flows. - -## Security - -See [SECURITY.md](./SECURITY.md) for vulnerability disclosure policy. - -Report data errors: [Open an issue](https://github.com/Ansvar-Systems/israel-law-mcp/issues/new?template=data-error.md) - -## License - -Apache-2.0 -- see [LICENSE](./LICENSE) - --- -Built by [Ansvar Systems](https://ansvar.eu) -- Cybersecurity compliance through AI-powered analysis. +## Example Queries + +Once connected, just ask naturally: + +- *"What does the Israeli data protection law say about consent?"* +- *"Search for cybersecurity requirements in Israeli legislation"* +- *"Is this statute still in force?"* +- *"Find provisions about personal data in Israeli law"* +- *"What EU directives does this Israeli law implement?"* +- *"Which Israeli laws implement the GDPR?"* +- *"Validate this legal citation"* +- *"Build a legal stance on data breach notification requirements"* + +--- + +## Available Tools (13) + +### Core Legal Research Tools (8) + +| Tool | Description | +|------|-------------| +| `search_legislation` | FTS5 full-text search across all provisions with BM25 ranking | +| `get_provision` | Retrieve specific provision by statute + chapter/section | +| `check_currency` | Check if statute is in force, amended, or repealed | +| `validate_citation` | Validate citation against database (zero-hallucination check) | +| `build_legal_stance` | Aggregate citations from statutes for a legal topic | +| `format_citation` | Format citations per Israeli conventions (full/short/pinpoint) | +| `list_sources` | List all available statutes with metadata | +| `about` | Server info, capabilities, and coverage summary | + +### EU/International Law Integration Tools (5) + +| Tool | Description | +|------|-------------| +| `get_eu_basis` | Get EU directives/regulations for Israeli statute | +| `get_israel_law_implementations` | Find Israeli laws implementing EU act | +| `search_eu_implementations` | Search EU documents with Israeli implementation counts | +| `get_provision_eu_basis` | Get EU law references for specific provision | +| `validate_eu_compliance` | Check implementation status of EU directives | + +--- + +## Why This Works + +**Verbatim Source Text (No LLM Processing):** +- All statute text is ingested from official Israeli government sources +- Provisions are returned **unchanged** from SQLite FTS5 database rows +- Zero LLM summarization or paraphrasing -- the database contains regulation text, not AI interpretations + +**Smart Context Management:** +- Search returns ranked provisions with BM25 scoring (safe for context) +- Provision retrieval gives exact text by statute identifier + chapter/section +- Cross-references help navigate without loading everything at once + +**Technical Architecture:** +``` +Official Sources --> Parse --> SQLite --> FTS5 snippet() --> MCP response + ^ ^ + Provision parser Verbatim database query +``` + +### Traditional Research vs. This MCP + +| Traditional Approach | This MCP Server | +|---------------------|-----------------| +| Search official databases by statute number | Search by plain language | +| Navigate multi-chapter statutes manually | Get the exact provision with context | +| Manual cross-referencing between laws | `build_legal_stance` aggregates across sources | +| "Is this statute still in force?" --> check manually | `check_currency` tool --> answer in seconds | +| Find EU basis --> dig through EUR-Lex | `get_eu_basis` --> linked EU directives instantly | +| No API, no integration | MCP protocol --> AI-native | + +--- + +## Data Sources & Freshness + +All content is sourced from authoritative Israeli legal databases: + +- **[Knesset](https://www.knesset.gov.il)** -- Official Israeli government legal database + +**Verified data only** -- every citation is validated against official sources. Zero LLM-generated content. + +--- + +## Security + +This project uses multiple layers of automated security scanning: + +| Scanner | What It Does | Schedule | +|---------|-------------|----------| +| **CodeQL** | Static analysis for security vulnerabilities | Weekly + PRs | +| **Semgrep** | SAST scanning (OWASP top 10, secrets, TypeScript) | Every push | +| **Gitleaks** | Secret detection across git history | Every push | +| **Trivy** | CVE scanning on filesystem and npm dependencies | Daily | +| **Socket.dev** | Supply chain attack detection | PRs | +| **Dependabot** | Automated dependency updates | Weekly | + +See [SECURITY.md](SECURITY.md) for the full policy and vulnerability reporting. + +--- + +## Important Disclaimers + +### Legal Advice + +> **THIS TOOL IS NOT LEGAL ADVICE** +> +> Statute text is sourced from official Israeli government publications. However: +> - This is a **research tool**, not a substitute for professional legal counsel +> - **Court case coverage is limited** -- do not rely solely on this for case law research +> - **Verify critical citations** against primary sources for court filings +> - **EU cross-references** are extracted from statute text, not EUR-Lex full text + +**Before using professionally, read:** [DISCLAIMER.md](DISCLAIMER.md) | [SECURITY.md](SECURITY.md) + +### Client Confidentiality + +Queries go through the Claude API. For privileged or confidential matters, use on-premise deployment. + +--- + +## Development + +### Setup + +```bash +git clone https://github.com/Ansvar-Systems/Israel-law-mcp +cd Israel-law-mcp +npm install +npm run build +npm test +``` + +### Running Locally + +```bash +npm run dev # Start MCP server +npx @anthropic/mcp-inspector node dist/index.js # Test with MCP Inspector +``` + +--- + +## Related Projects: Complete Compliance Suite + +This server is part of **Ansvar's Compliance Suite** -- MCP servers that work together for end-to-end compliance coverage: + +### [@ansvar/eu-regulations-mcp](https://github.com/Ansvar-Systems/EU_compliance_MCP) +**Query 49 EU regulations directly from Claude** -- GDPR, AI Act, DORA, NIS2, MiFID II, eIDAS, and more. Full regulatory text with article-level search. `npx @ansvar/eu-regulations-mcp` + +### [@ansvar/us-regulations-mcp](https://github.com/Ansvar-Systems/US_Compliance_MCP) +**Query US federal and state compliance laws** -- HIPAA, CCPA, SOX, GLBA, FERPA, and more. `npx @ansvar/us-regulations-mcp` + +### [@ansvar/security-controls-mcp](https://github.com/Ansvar-Systems/security-controls-mcp) +**Query 261 security frameworks** -- ISO 27001, NIST CSF, SOC 2, CIS Controls, SCF, and more. `npx @ansvar/security-controls-mcp` + +### [@ansvar/automotive-cybersecurity-mcp](https://github.com/Ansvar-Systems/Automotive-MCP) +**Query UNECE R155/R156 and ISO 21434** -- Automotive cybersecurity compliance. `npx @ansvar/automotive-cybersecurity-mcp` + +**30+ national law MCPs** covering Australia, Brazil, Canada, China, Denmark, Finland, France, Germany, Ghana, Iceland, India, Ireland, Israel, Italy, Japan, Kenya, Netherlands, Nigeria, Norway, Singapore, Slovenia, South Korea, Sweden, Switzerland, Thailand, UAE, UK, and more. + +--- + +## Contributing + +Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. + +Priority areas: +- Court case law expansion +- EU cross-reference improvements +- Historical statute versions and amendment tracking +- Additional statutory instruments and regulations + +--- + +## Roadmap + +- [x] Core statute database with FTS5 search +- [x] EU/international law cross-references +- [x] Vercel Streamable HTTP deployment +- [x] npm package publication +- [ ] Court case law expansion +- [ ] Historical statute versions (amendment tracking) +- [ ] Preparatory works / explanatory memoranda +- [ ] Lower court and tribunal decisions + +--- + +## Citation + +If you use this MCP server in academic research: + +```bibtex +@software{israel_law_mcp_2025, + author = {Ansvar Systems AB}, + title = {Israeli Law MCP Server: AI-Powered Legal Research Tool}, + year = {2025}, + url = {https://github.com/Ansvar-Systems/Israel-law-mcp}, + note = {Israeli legal database with full-text search and EU cross-references} +} +``` + +--- + +## License + +Apache License 2.0. See [LICENSE](./LICENSE) for details. + +### Data Licenses + +- **Statutes & Legislation:** Israeli Government (public domain) +- **EU Metadata:** EUR-Lex (EU public domain) + +--- + +## About Ansvar Systems + +We build AI-accelerated compliance and legal research tools for the global market. This MCP server started as our internal reference tool -- turns out everyone building compliance tools has the same research frustrations. + +So we're open-sourcing it. + +**[ansvar.eu](https://ansvar.eu)** -- Stockholm, Sweden + +--- + +

+ Built with care in Stockholm, Sweden +