[MseeP.ai Security Assessment Badge](https://mseep.ai/app/protomated-legal-context)

# LegalContext

LegalContext is an open-source Model Context Protocol (MCP) server that creates a secure bridge between a law firm's Clio document management system and Claude Desktop AI assistant.

<p align="center">
  
  
  
</p>

## Features

- **Secure Document Access**: Connects to Clio API to access legal documents while maintaining complete security and confidentiality
- **Local Processing**: All document processing happens locally within your firm's infrastructure, ensuring client data never leaves your security perimeter
- **MCP Integration**: Seamlessly integrates with Claude Desktop through the Model Context Protocol (MCP)
- **Semantic Search**: Uses LanceDB for efficient vector search, enabling Claude to find the most relevant documents based on meaning, not just keywords
- **Citation Tracking**: All Claude responses include proper citations to your source documents
- **Free Tier Limitations**: Includes reasonable limits for the free version (100 documents, 50 queries/day)

## Why LegalContext?

For legal professionals, the intersection of AI capabilities and client confidentiality creates a significant challenge:

1. **The AI Hallucination Problem**: Large language models like Claude can provide incorrect or fabricated information. This is particularly dangerous in legal contexts where accuracy is paramount.

2. **The Client Confidentiality Dilemma**: Traditional AI tools require uploading documents to external servers, potentially compromising client confidentiality and attorney-client privilege.

LegalContext solves both problems by:

1. **Grounding Claude's responses in your actual documents** - eliminating hallucinations by using Retrieval-Augmented Generation (RAG)
2. **Processing all documents locally** - maintaining complete data control and meeting confidentiality requirements
3. **Creating a secure bridge to Claude Desktop** - leveraging AI capabilities without exposing sensitive information

## Table of Contents

- [Prerequisites](#prerequisites)
- [Quick Start](#quick-start)
- [Detailed Installation](#detailed-installation)
   - [Automated Setup](#automated-setup)
   - [Manual Setup](#manual-setup)
- [Claude Desktop Integration](#claude-desktop-integration)
- [Clio Setup](#clio-setup)
- [Usage Guide](#usage-guide)
   - [Authentication](#authentication)
   - [Indexing Documents](#indexing-documents)
   - [Using with Claude Desktop](#using-with-claude-desktop)
- [Security Features](#security-features)
- [Free Tier Limitations](#free-tier-limitations)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)

## Prerequisites

- **Bun**: Version 1.0 or later (JavaScript runtime and package manager)
- **Clio**: A Clio account with API access and registered application credentials
- **Claude Desktop**: Anthropic's Claude Desktop application
- **Operating System**: macOS, Linux, or Windows with WSL

## Quick Start

```bash
# Clone the repository
git clone https://github.com/protomated/legal-context.git
cd legal-context

# Install dependencies
bun install

# Run the setup script (automated configuration)
./install.sh

# The script will set up everything including an initial document indexing
# Start Claude Desktop and verify that LegalContext appears as an MCP server
# In Claude Desktop, ask a legal question that requires document access
# Example: "What are the key provisions in our standard NDA?"
```

## Detailed Installation

### Automated Setup

Our automated setup script handles the complete configuration process for you:

```bash
# Run the setup script
./install.sh
```

The script will:
1. Check for Bun installation or install it if needed
2. Configure necessary environment variables in .env
3. Create Claude Desktop configuration file automatically with the correct paths and environment variables
4. Guide you through Clio OAuth setup
5. Run an initial batch indexing of your documents (up to 100 for free tier)

This is the recommended approach as it ensures all components are correctly configured.

### Manual Setup

If you prefer to set up manually:

1. **Install Bun**
   ```bash
   curl -fsSL https://bun.sh/install | bash
   ```

2. **Clone the repository**
   ```bash
   git clone https://github.com/protomated/legal-context.git
   cd legal-context
   ```

3. **Install dependencies**
   ```bash
   bun install
   ```

4. **Configure environment variables**
   ```bash
   cp .env.example .env
   ```
   Edit `.env` with your Clio credentials and other settings

5. **Configure Claude Desktop**
   Create or edit the Claude Desktop configuration file (see [Claude Desktop Integration](#claude-desktop-integration))

6. **Start the server**
   ```bash
   bun run src/server.ts
   ```

## Claude Desktop Integration

LegalContext communicates with Claude Desktop using the Model Context Protocol (MCP). To configure Claude Desktop to use LegalContext:

### Automated Configuration (Recommended)

The `install.sh` script will automatically create or update the Claude Desktop configuration file. After running the script, simply restart Claude Desktop to apply the changes.

### Manual Configuration

Create or edit the Claude Desktop configuration file at:

#### macOS
```
~/Library/Application Support/Claude/claude_desktop_config.json
```

#### Windows
```
%APPDATA%\Claude\claude_desktop_config.json
```

#### Linux
```
~/.config/Claude/claude_desktop_config.json
```

Add the following configuration (adjust paths and environment variables for your system):

```json
{
  "mcpServers": {
    "legalcontext": {
      "command": "/path/to/bun",
      "args": [
        "/path/to/legal-context/src/server.ts"
      ],
      "cwd": "/path/to/legal-context",
      "env": {
        "CLIO_CLIENT_ID": "your_clio_client_id",
        "CLIO_CLIENT_SECRET": "your_clio_client_secret",
        "CLIO_REDIRECT_URI": "http://127.0.0.1:3001/clio/auth/callback",
        "CLIO_API_REGION": "us"
      }
    }
  }
}
```

**Important Notes:**
1. Replace the command path with the full path to your Bun executable (find using `which bun`)
2. Replace the args path with the full absolute path to your server.ts file
3. Add your actual Clio API credentials in the env section
4. The environment variables in this config will override your .env file

### Verifying the Integration

1. Start Claude Desktop
2. Go to Settings > Developer
3. You should see "legalcontext" listed as an MCP server with status "Running"
4. If it shows "Not running" or doesn't appear:
   - Ensure the paths in your configuration are absolute and correct for your system
   - Verify that the Bun executable path is correct (use `which bun` to find it)
   - Check that you have the correct environment variables set
   - Restart Claude Desktop after making configuration changes
   - Check the logs at:
      - macOS: `~/Library/Logs/Claude/legalcontext.log`
      - Windows: `%USERPROFILE%\AppData\Local\Claude\Logs\legalcontext.log`

### Testing the Integration

Once the integration is set up, you can test it with a simple query in Claude Desktop:

1. Open Claude Desktop
2. Type: "Can you check if LegalContext is working?"
3. Claude should respond that it can access the LegalContext tools
4. Try a document query like: "What documents do we have in our Clio account?"

## Clio Setup

### Creating a Clio API Application

1. Visit [Clio Developers Portal](https://app.clio.com/settings/developer_applications)
   - Use the appropriate regional URL if not using the US version of Clio
2. Click "New Application"
3. Enter application details:
   - **Name**: "LegalContext"
   - **Redirect URI**: `http://127.0.0.1:3001/clio/auth/callback`
   - **Scopes**: Enable `documents` and `folders` scopes
4. Save the application and note your Client ID and Client Secret
5. Add these credentials to your `.env` file or directly to your Claude Desktop configuration

## Usage Guide

### Authentication

1. Start Claude Desktop (which will automatically launch LegalContext)
2. Open a browser and navigate to:
   ```
   http://localhost:3001/clio/auth
   ```
3. Follow the Clio OAuth flow to authorize LegalContext
4. You'll be redirected to a success page once authentication completes

### Indexing Documents

The installation script automatically runs an initial batch indexing process for your documents (up to the free tier limit of 100).

For additional documents or to refresh the index, you can:

Ask Claude to index specific documents:

```
Claude, please index the document with ID 12345 from our Clio account.
```

Or use the batch indexing tool directly:

```bash
bun run index:batch
```

### Using with Claude Desktop

Once your documents are indexed, you can ask Claude questions about them:

- **Document search**: "Find all employment contracts drafted in the last year"
- **Document analysis**: "What are the key provisions in our standard NDA?"
- **Legal research**: "Summarize our precedents for data privacy cases"
- **Contract comparison**: "How does the Johnson contract compare to our standard terms?"

Claude will use the LegalContext tools to search your document repository, retrieve the most relevant documents, ground its answers in your actual documents, and provide citations to the source documents.

## Security Features

LegalContext prioritizes security and confidentiality:

- **Local Processing**: All document content is processed within your infrastructure
- **Secure OAuth**: Uses industry-standard OAuth 2.0 for Clio authentication
- **Encrypted Token Storage**: Access tokens are securely stored with encryption
- **No Cloud Dependencies**: Documents are never sent to external AI services
- **Full Transparency**: Open-source codebase allows complete security audit
- **Centralized Data Storage**: All data is stored in the `~/.legalcontext` directory in your home folder

## Free Tier Limitations

The free version of LegalContext includes reasonable limitations:

- **Document Limit**: Maximum of 100 indexed documents
- **Query Limit**: 50 queries per day
- **Single Instance**: Designed for individual use rather than firm-wide deployment

These limitations ensure the project remains sustainable while providing value to individual legal practitioners.

## Troubleshooting

### Common Issues

1. **"Clio API client not initialized"**
   - Ensure you've completed the Clio authentication process
   - Check your Clio API credentials in `.env` or Claude Desktop config
   - Verify the redirect URI matches your Clio application settings
   - Try running `bun run auth:simple` to test authentication

2. **"No documents found in vector search"**
   - Make sure you've indexed documents with `bun run index:batch`
   - Check that your documents are in a compatible format (PDF, DOCX)
   - Verify that the documents exist in your Clio account
   - Look at the `~/.legalcontext/indexed_documents.json` file to see which documents are indexed

3. **LegalContext not appearing in Claude Desktop**
   - Ensure the Claude Desktop configuration file has the correct format and location
   - Use absolute paths for both the Bun executable and the server.ts file
   - Verify all required environment variables are set in the config
   - Check that LegalContext server is running (`bun start` in a terminal)
   - Restart Claude Desktop after configuration changes
   - Look at the logs in `~/Library/Logs/Claude/legalcontext.log` (macOS)

### Data Storage

LegalContext stores all its data in the `~/.legalcontext` directory in your home folder. This includes:

- **LanceDB database**: `~/.legalcontext/lancedb` - Contains the vector embeddings for document search
- **Clio tokens**: `~/.legalcontext/clio_tokens` - Stores your Clio API authentication tokens
- **Indexed documents**: `~/.legalcontext/indexed_documents.json` - Tracks which documents have been indexed
- **Query counter**: `~/.legalcontext/query_counter.json` - Tracks daily query usage for free tier limitations

If you need to reset the application, you can delete this directory, but you'll need to re-authenticate with Clio and re-index your documents.

### Diagnostic Tools

LegalContext includes several diagnostic tools:

```bash
# Test Clio authentication
bun run auth:simple

# Check Clio API access
bun run check:clio

# Test document processing
bun run test:extraction

# Reset indexing state
bun run src/tools/reset-index-tracking.ts
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create a feature branch: `git checkout -b feature/amazing-feature`
3. Commit your changes: `git commit -m 'Add amazing feature'`
4. Push to the branch: `git push origin feature/amazing-feature`
5. Open a Pull Request

## License

This project is licensed under the [Mozilla Public License 2.0](LICENSE) - see the LICENSE file for details.

---

## Support

For assistance, please:
- Open an issue on GitHub
- Email the team at team@protomated.com
- Visit our website at [protomated.com](https://protomated.com)

---

Attribution added by YourAIKit. It is not part of the upstream file.

- Source: https://github.com/protomated/legal-context-ce
- Credit: Protomated, LegalContext
- Upstream copy: protomated/legal-context-ce at commit 5537454fae234b514ca739840acfd150c0d73981, README.md
- Copyright: held by the upstream authors credited above
- License: MPL-2.0. Full text: https://youraikit.com/licenses/protomated-legal-context-ce-root/LICENSE
- Changes: YourAIKit removed 4 embedded images (badges, logos, or pictures); a linked image keeps its link as text.
- The full upstream license text (LICENSE) follows.

License (LICENSE):

```text
Mozilla Public License Version 2.0
==================================

1. Definitions
--------------

1.1. "Contributor"
    means each individual or legal entity that creates, contributes to
    the creation of, or owns Covered Software.

1.2. "Contributor Version"
    means the combination of the Contributions of others (if any) used
    by a Contributor and that particular Contributor's Contribution.

1.3. "Contribution"
    means Covered Software of a particular Contributor.

1.4. "Covered Software"
    means Source Code Form to which the initial Contributor has attached
    the notice in Exhibit A, the Executable Form of such Source Code
    Form, and Modifications of such Source Code Form, in each case
    including portions thereof.

1.5. "Incompatible With Secondary Licenses"
    means

    (a) that the initial Contributor has attached the notice described
        in Exhibit B to the Covered Software; or

    (b) that the Covered Software was made available under the terms of
        version 1.1 or earlier of the License, but not also under the
        terms of a Secondary License.

1.6. "Executable Form"
    means any form of the work other than Source Code Form.

1.7. "Larger Work"
    means a work that combines Covered Software with other material, in
    a separate file or files, that is not Covered Software.

1.8. "License"
    means this document.

1.9. "Licensable"
    means having the right to grant, to the maximum extent possible,
    whether at the time of the initial grant or subsequently, any and
    all of the rights conveyed by this License.

1.10. "Modifications"
    means any of the following:

    (a) any file in Source Code Form that results from an addition to,
        deletion from, or modification of the contents of Covered
        Software; or

    (b) any new file in Source Code Form that contains any Covered
        Software.

1.11. "Patent Claims" of a Contributor
    means any patent claim(s), including without limitation, method,
    process, and apparatus claims, in any patent Licensable by such
    Contributor that would be infringed, but for the grant of the
    License, by the making, using, selling, offering for sale, having
    made, import, or transfer of either its Contributions or its
    Contributor Version.

1.12. "Secondary License"
    means either the GNU General Public License, Version 2.0, the GNU
    Lesser General Public License, Version 2.1, the GNU Affero General
    Public License, Version 3.0, or any later versions of those
    licenses.

1.13. "Source Code Form"
    means the form of the work preferred for making modifications.

1.14. "You" (or "Your")
    means an individual or a legal entity exercising rights under this
    License. For legal entities, "You" includes any entity that
    controls, is controlled by, or is under common control with You. For
    purposes of this definition, "control" means (a) the power, direct
    or indirect, to cause the direction or management of such entity,
    whether by contract or otherwise, or (b) ownership of more than
    fifty percent (50%) of the outstanding shares or beneficial
    ownership of such entity.

2. License Grants and Conditions
--------------------------------

2.1. Grants

Each Contributor hereby grants You a world-wide, royalty-free,
non-exclusive license:

(a) under intellectual property rights (other than patent or trademark)
    Licensable by such Contributor to use, reproduce, make available,
    modify, display, perform, distribute, and otherwise exploit its
    Contributions, either on an unmodified basis, with Modifications, or
    as part of a Larger Work; and

(b) under Patent Claims of such Contributor to make, use, sell, offer
    for sale, have made, import, and otherwise transfer either its
    Contributions or its Contributor Version.

2.2. Effective Date

The licenses granted in Section 2.1 with respect to any Contribution
become effective for each Contribution on the date the Contributor first
distributes such Contribution.

2.3. Limitations on Grant Scope

The licenses granted in this Section 2 are the only rights granted under
this License. No additional rights or licenses will be implied from the
distribution or licensing of Covered Software under this License.
Notwithstanding Section 2.1(b) above, no patent license is granted by a
Contributor:

(a) for any code that a Contributor has removed from Covered Software;
    or

(b) for infringements caused by: (i) Your and any other third party's
    modifications of Covered Software, or (ii) the combination of its
    Contributions with other software (except as part of its Contributor
    Version); or

(c) under Patent Claims infringed by Covered Software in the absence of
    its Contributions.

This License does not grant any rights in the trademarks, service marks,
or logos of any Contributor (except as may be necessary to comply with
the notice requirements in Section 3.4).

2.4. Subsequent Licenses

No Contributor makes additional grants as a result of Your choice to
distribute the Covered Software under a subsequent version of this
License (see Section 10.2) or under the terms of a Secondary License (if
permitted under the terms of Section 3.3).

2.5. Representation

Each Contributor represents that the Contributor believes its
Contributions are its original creation(s) or it has sufficient rights
to grant the rights to its Contributions conveyed by this License.

2.6. Fair Use

This License is not intended to limit any rights You have under
applicable copyright doctrines of fair use, fair dealing, or other
equivalents.

2.7. Conditions

Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
in Section 2.1.

3. Responsibilities
-------------------

3.1. Distribution of Source Form

All distribution of Covered Software in Source Code Form, including any
Modifications that You create or to which You contribute, must be under
the terms of this License. You must inform recipients that the Source
Code Form of the Covered Software is governed by the terms of this
License, and how they can obtain a copy of this License. You may not
attempt to alter or restrict the recipients' rights in the Source Code
Form.

3.2. Distribution of Executable Form

If You distribute Covered Software in Executable Form then:

(a) such Covered Software must also be made available in Source Code
    Form, as described in Section 3.1, and You must inform recipients of
    the Executable Form how they can obtain a copy of such Source Code
    Form by reasonable means in a timely manner, at a charge no more
    than the cost of distribution to the recipient; and

(b) You may distribute such Executable Form under the terms of this
    License, or sublicense it under different terms, provided that the
    license for the Executable Form does not attempt to limit or alter
    the recipients' rights in the Source Code Form under this License.

3.3. Distribution of a Larger Work

You may create and distribute a Larger Work under terms of Your choice,
provided that You also comply with the requirements of this License for
the Covered Software. If the Larger Work is a combination of Covered
Software with a work governed by one or more Secondary Licenses, and the
Covered Software is not Incompatible With Secondary Licenses, this
License permits You to additionally distribute such Covered Software
under the terms of such Secondary License(s), so that the recipient of
the Larger Work may, at their option, further distribute the Covered
Software under the terms of either this License or such Secondary
License(s).

3.4. Notices

You may not remove or alter the substance of any license notices
(including copyright notices, patent notices, disclaimers of warranty,
or limitations of liability) contained within the Source Code Form of
the Covered Software, except that You may alter any license notices to
the extent required to remedy known factual inaccuracies.

3.5. Application of Additional Terms

You may choose to offer, and to charge a fee for, warranty, support,
indemnity or liability obligations to one or more recipients of Covered
Software. However, You may do so only on Your own behalf, and not on
behalf of any Contributor. You must make it absolutely clear that any
such warranty, support, indemnity, or liability obligation is offered by
You alone, and You hereby agree to indemnify every Contributor for any
liability incurred by such Contributor as a result of warranty, support,
indemnity or liability terms You offer. You may include additional
disclaimers of warranty and limitations of liability specific to any
jurisdiction.

4. Inability to Comply Due to Statute or Regulation
---------------------------------------------------

If it is impossible for You to comply with any of the terms of this
License with respect to some or all of the Covered Software due to
statute, judicial order, or regulation then You must: (a) comply with
the terms of this License to the maximum extent possible; and (b)
describe the limitations and the code they affect. Such description must
be placed in a text file included with all distributions of the Covered
Software under this License. Except to the extent prohibited by statute
or regulation, such description must be sufficiently detailed for a
recipient of ordinary skill to be able to understand it.

5. Termination
--------------

5.1. The rights granted under this License will terminate automatically
if You fail to comply with any of its terms. However, if You become
compliant, then the rights granted under this License from a particular
Contributor are reinstated (a) provisionally, unless and until such
Contributor explicitly and finally terminates Your grants, and (b) on an
ongoing basis, if such Contributor fails to notify You of the
non-compliance by some reasonable means prior to 60 days after You have
come back into compliance. Moreover, Your grants from a particular
Contributor are reinstated on an ongoing basis if such Contributor
notifies You of the non-compliance by some reasonable means, this is the
first time You have received notice of non-compliance with this License
from such Contributor, and You become compliant prior to 30 days after
Your receipt of the notice.

5.2. If You initiate litigation against any entity by asserting a patent
infringement claim (excluding declaratory judgment actions,
counter-claims, and cross-claims) alleging that a Contributor Version
directly or indirectly infringes any patent, then the rights granted to
You by any and all Contributors for the Covered Software under Section
2.1 of this License shall terminate.

5.3. In the event of termination under Sections 5.1 or 5.2 above, all
end user license agreements (excluding distributors and resellers) which
have been validly granted by You or Your distributors under this License
prior to termination shall survive termination.

************************************************************************
*                                                                      *
*  6. Disclaimer of Warranty                                           *
*  -------------------------                                           *
*                                                                      *
*  Covered Software is provided under this License on an "as is"       *
*  basis, without warranty of any kind, either expressed, implied, or  *
*  statutory, including, without limitation, warranties that the       *
*  Covered Software is free of defects, merchantable, fit for a        *
*  particular purpose or non-infringing. The entire risk as to the     *
*  quality and performance of the Covered Software is with You.        *
*  Should any Covered Software prove defective in any respect, You     *
*  (not any Contributor) assume the cost of any necessary servicing,   *
*  repair, or correction. This disclaimer of warranty constitutes an   *
*  essential part of this License. No use of any Covered Software is   *
*  authorized under this License except under this disclaimer.         *
*                                                                      *
************************************************************************

************************************************************************
*                                                                      *
*  7. Limitation of Liability                                          *
*  --------------------------                                          *
*                                                                      *
*  Under no circumstances and under no legal theory, whether tort      *
*  (including negligence), contract, or otherwise, shall any           *
*  Contributor, or anyone who distributes Covered Software as          *
*  permitted above, be liable to You for any direct, indirect,         *
*  special, incidental, or consequential damages of any character      *
*  including, without limitation, damages for lost profits, loss of    *
*  goodwill, work stoppage, computer failure or malfunction, or any    *
*  and all other commercial damages or losses, even if such party      *
*  shall have been informed of the possibility of such damages. This   *
*  limitation of liability shall not apply to liability for death or   *
*  personal injury resulting from such party's negligence to the       *
*  extent applicable law prohibits such limitation. Some               *
*  jurisdictions do not allow the exclusion or limitation of           *
*  incidental or consequential damages, so this exclusion and          *
*  limitation may not apply to You.                                    *
*                                                                      *
************************************************************************

8. Litigation
-------------

Any litigation relating to this License may be brought only in the
courts of a jurisdiction where the defendant maintains its principal
place of business and such litigation shall be governed by laws of that
jurisdiction, without reference to its conflict-of-law provisions.
Nothing in this Section shall prevent a party's ability to bring
cross-claims or counter-claims.

9. Miscellaneous
----------------

This License represents the complete agreement concerning the subject
matter hereof. If any provision of this License is held to be
unenforceable, such provision shall be reformed only to the extent
necessary to make it enforceable. Any law or regulation which provides
that the language of a contract shall be construed against the drafter
shall not be used to construe this License against a Contributor.

10. Versions of the License
---------------------------

10.1. New Versions

Mozilla Foundation is the license steward. Except as provided in Section
10.3, no one other than the license steward has the right to modify or
publish new versions of this License. Each version will be given a
distinguishing version number.

10.2. Effect of New Versions

You may distribute the Covered Software under the terms of the version
of the License under which You originally received the Covered Software,
or under the terms of any subsequent version published by the license
steward.

10.3. Modified Versions

If you create software not governed by this License, and you want to
create a new license for such software, you may create and use a
modified version of this License if you rename the license and remove
any references to the name of the license steward (except to note that
such modified license differs from this License).

10.4. Distributing Source Code Form that is Incompatible With Secondary
Licenses

If You choose to distribute Source Code Form that is Incompatible With
Secondary Licenses under the terms of this version of the License, the
notice described in Exhibit B of this License must be attached.

Exhibit A - Source Code Form License Notice
-------------------------------------------

  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.

If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to look
for such a notice.

You may add additional accurate notices of copyright ownership.

Exhibit B - "Incompatible With Secondary Licenses" Notice
---------------------------------------------------------

  This Source Code Form is "Incompatible With Secondary Licenses", as
  defined by the Mozilla Public License, v. 2.0.
```
