Skip to main content
Glama
ArmaghanRazaChaudhary

ContractAudit MCP Server

ContractAudit RAG

Local-first retrieval for EVM smart-contract security knowledge — crawl, index, cite.

ContractAudit is an audit research assistant: it crawls an explicit source allowlist, extracts HTML/PDF, builds provenance-preserving chunks (LlamaIndex), stores hybrid dense + BM25 vectors in Qdrant, and exposes read-only search through MCP.

It helps you find what auditors and docs already said about a class of bugs. It is not a certificate that any contract is safe.

approved sources → governed crawler → parsers → LlamaIndex chunks
        → Qdrant (hybrid) → retrieval service → MCP tools → (optional) local LLM host

What it does

Capability

Details

Governed crawling

Domain / path allowlists, crawl delay, size caps, storage_approved gate

Ingestion

HTML + PDF extraction, chunking with stable IDs + provenance

Hybrid search

Dense embeddings (BAAI/bge-small-en-v1.5) + sparse/BM25 via Qdrant

MCP server

Read-only tools for IDE / agent hosts (stdio or local HTTP)

Eval harness

Starter benchmark queries in eval/evm_queries.yaml

LLM seam

Optional host retrieves evidence via MCP, then calls your local ask()

MCP tools: search_security_knowledge · get_audit_finding · get_document_context · list_sources · corpus_status

Crawling and indexing stay operator-controlled CLI actions so prompt content cannot mutate the corpus.


Related MCP server: claudit

Tech stack

Layer

Technology

Language

Python 3.11+, packaged with Hatchling

CLI

Typer (contract-audit-rag, contract-audit-mcp)

Config

Pydantic Settings, YAML source policies

Crawl / parse

httpx, BeautifulSoup, trafilatura, pypdf

Chunking / RAG

LlamaIndex + HuggingFace embeddings

Vector DB

Qdrant (embedded path or server URL)

Sparse vectors

fastembed

Agent interface

MCP (mcp[cli]) — stdio / streamable-HTTP

Quality

pytest, ruff, mypy (strict)

Optional: OCR extras (pymupdf, pytesseract) · docs PDF builder (reportlab).


Privacy & repo hygiene

Included

Excluded (local only)

Source code, tests, config/sources.yaml

.env

.env.example, eval queries, docs

.venv/, caches

Learning guide (md/pdf)

data/raw/, data/qdrant/, data/manifest.sqlite3

No API keys are required for the default local embedding path. Do not commit crawled corpora or vector stores.


Quick start (Windows)

python -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e ".[dev]"
Copy-Item .env.example .env

First search/ingest downloads embedding models. Default dense model runs on CPU; set CAR_EMBEDDING_DEVICE=cuda only if VRAM allows.

Embedded Qdrant (data/qdrant) allows one process at a time. For concurrent ingest + MCP, run Qdrant as a service and set CAR_QDRANT_URL=http://localhost:6333.

Build a small corpus

Review config/sources.yaml first (robots, terms, report licenses).

contract-audit-rag sources validate
contract-audit-rag crawl --source trailofbits_secure_contracts --limit 30
contract-audit-rag ingest
contract-audit-rag stats
contract-audit-rag search "How should oracle price freshness be checked?"
contract-audit-rag benchmark

MCP

contract-audit-mcp

For a local network client: CAR_MCP_TRANSPORT=streamable-http (default 127.0.0.1:8765). Do not expose publicly without auth/TLS.

Tests

ruff check .
mypy src
pytest

Optional local-model phase

Wire any local model callable through contract_audit_rag.llm.base.CallableAdapter, then use MCPQwenHost.answer() with a connected MCP ClientSession. The host:

  1. Calls search_security_knowledge

  2. Validates structured evidence

  3. Builds an evidence_prompt (untrusted web content, required citations, insufficient-evidence path)

The raw model is not an MCP client — the application host owns tool calls.


Repo map

ContractAudit/
├── config/sources.yaml          # Crawl allowlist (review before use)
├── src/contract_audit_rag/
│   ├── cli.py                   # Typer CLI
│   ├── ingestion/               # Crawler, parsers, pipeline, chunking
│   ├── retrieval/               # Search service
│   ├── indexing.py              # Qdrant index store
│   ├── mcp/server.py            # MCP tools
│   └── llm/                     # Optional host + adapter seam
├── eval/evm_queries.yaml
├── tests/
├── docs/                        # Learning guide (md + pdf)
├── tools/build_learning_guide.py
├── .env.example
└── pyproject.toml

Design notes

  • Allowlist-first security posture for anything that hits the network.

  • Provenance-preserving chunks so answers can be cited, not hand-waved.

  • Read-only MCP surface — corpus mutation is never a tool side effect.

  • Hybrid retrieval for both semantic and keyword-heavy audit jargon.

  • Honest product boundary: research assistant ≠ automated audit sign-off.


Learning guide

Detailed walkthrough: docs/Contract_Audit_RAG_Learning_Guide.pdf (Markdown source alongside).

python -m pip install -e ".[docs]"
python tools\build_learning_guide.py

License

MIT — see LICENSE. Respect third-party content licenses when crawling or redistributing reports.

Available Tools

3 tools
corpus_statusA

Return corpus, vector collection, and embedding model status.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.8/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided; description carries full burden. Only states it returns status but does not disclose any behavioral traits like read-only nature, authentication requirements, or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single, concise sentence that directly conveys the tool's function with no excess words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given zero parameters and presence of output schema, description is adequate but could mention if status is real-time or any prerequisites. Siblings provide enough differentiation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

No parameters (coverage 100%), baseline 4. Description adds meaning by specifying the components of the status (corpus, vector collection, embedding model), which is helpful beyond the empty schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Clearly states verb 'Return' and resource 'corpus, vector collection, and embedding model status'. Differentiates from sibling tools get_document_context and list_sources, which have different purposes.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies usage for obtaining status but does not explicitly state when to use or when not to use. No mention of alternatives or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_document_contextC

Return ordered chunks from one source document.

ParametersJSON Schema
NameRequiredDescriptionDefault
limitNo
document_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden but only states 'Return ordered chunks,' implying a read operation. No behavioral traits (e.g., permissions, rate limits, idempotency) are disclosed, which is insufficient for a mutation-free analysis tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no waste, but it is too brief for a tool with parameters and no schema descriptions. Front-loading the core action is good, but essential details are missing, making it minimally adequate.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of an output schema, return values are not strictly required. However, the description fails to explain how the 'ordered chunks' are organized, how 'limit' affects results, or what 'document_id' refers to, leaving significant gaps for a tool with two parameters and no param descriptions.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, yet the description adds no meaning to the two parameters. 'document_id' and 'limit' are not explained, leaving the agent to infer their purposes without any additional context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool returns ordered chunks from one source document, specifying the verb (Return) and resource (ordered chunks from one source document). It distinguishes from sibling tools like list_sources and corpus_status, which likely provide different functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. There is no mention of prerequisites, limitations, or exclusion criteria, leaving the agent without context for appropriate usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_sourcesA

List ingested source documents, licenses, URLs, and processing states.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the burden. It indicates a read operation ('list'), which is inherently safe, but does not disclose any additional traits like pagination, rate limits, or behavior when empty.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence with no extraneous words. Every word earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no parameters and an existing output schema, the description adequately covers the basic purpose. It could mention scope (all sources) but is sufficient for a simple list operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are zero parameters, so baseline is 4. The description can add value but is not required to explain parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'list' and the resource 'ingested source documents, licenses, URLs, and processing states', and it distinguishes from siblings like get_document_context (single document) and corpus_status (overall status).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool vs alternatives or any exclusions. The description only states what it does without context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

TDQS

B3.2/5.0
Disambiguation5/5

Each tool targets a clearly distinct aspect of the server: retrieving document content, listing source metadata, and reporting system status. No overlapping functionality.

Naming Consistency4/5

Most names follow a verb_noun pattern (get_document_context, list_sources), but corpus_status is a noun_noun pair without a verb, breaking full consistency. Overall pattern is clear and readable.

Tool Count3/5

Three tools is on the low end for a contract audit server, but could be acceptable if the server is narrowly scoped. It borders on feeling thin.

Completeness2/5

The tool set lacks essential operations like adding or deleting sources, searching across documents, or comparing contracts. Significant gaps impair full audit workflows.

Maintenance

ActivitySlowing
ResponsivenessSyncing

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • A
    license
    A
    quality
    D
    maintenance
    Provides instant access to authoritative security documentation from organizations like OWASP, NIST, and major cloud providers through natural language semantic search. It enables users to retrieve security best practices, frameworks, and vulnerability information directly from a locally cached knowledge base.
    4
    1
    MIT
  • A
    license
    A
    quality
    D
    maintenance
    Enables searching over 20,000+ smart contract audit findings from Solodit, with filters for severity, firm, tags, and more. Designed for use with AI coding agents like Claude Code and Codex CLI.
    4
    32
    157
    MIT
  • A
    license
    B
    quality
    B
    maintenance
    Provides read-only hybrid RAG search and discovery over a local-first AI knowledge corpus, enabling semantic and keyword search, browse, digest, and status tools.
    4
    PolyForm Noncommercial 1.0.0
  • A
    license
    C
    quality
    D
    maintenance
    Enables AI agents and security researchers to query a curated knowledge base of 1,032 verified smart contract vulnerability findings from Sherlock audit contests, including acceptance rates and examples per vulnerability pattern.
    3
    63
    3
    MIT

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ArmaghanRazaChaudhary/ContractAudit'

If you have feedback or need assistance with the MCP directory API, please join our Discord server