# lockdocs

> lockdocs is a freemium MCP server for developer tools. Answers library questions from the docs of the exact version in your lockfile, offline. It runs locally on your machine and is started by your AI client.

- **Kind:** MCP server
- **Pricing:** Freemium
- **Platforms:** CLI, self-hosted
- **Website:** https://sylphxai.github.io/lockdocs/
- **Repository:** https://github.com/sylphxai/lockdocs
- **MCP Registry name:** io.github.SylphxAI/lockdocs
- **Categories:** developer tools
- **Listing updated:** 2026-11-15

## About

Instead of looking up a library by name and guessing a version, it reads your lockfile and answers from the docs and type declarations of what you installed. The demo shows the same question giving model_dump() on pydantic 2.9.2 and BaseModel.dict() on pydantic 1.10.18. Lockfiles supported include npm, pnpm, yarn, bun, Cargo.lock, uv, poetry, Pipfile, requirements and go.mod.

Docs come from files already on disk: READMEs, changelogs, docs folders, and API reference built from .d.ts and JSDoc, Python docstrings, rustdoc and Go doc comments, private packages included. For frameworks that ship no docs, the first query can add upstream GitHub docs at the commit of your pinned tag; --no-fetch and --offline switch that off. Hybrid BM25 and a small local embedding model pack each answer into a 1,200-token budget, with every section cited as package@version path:line.

Three tools are exposed: resolve, docs and api. It is a single Rust binary, MIT licensed, with a CLI as well. The vendor reports 96 of 105 version-sensitive questions answered right after a fetch, against 77 for Context7. A paid Pro tier adds upgrade reports and private registries.

## Features

- **Lockfile-aware:** Reads your lockfile so answers match the installed version.
- **Cited answers:** Every section is cited as package@version path:line.
- **Offline after first fetch:** Runs without network once the model and docs are cached.
- **Local search:** Hybrid BM25 and a small local embedding model within a 1,200-token budget.
- **Upgrade report:** Pro lists APIs you call that change between two versions.
- **CLI and MCP:** One Rust binary serves both a command line and an MCP server.

## Good for

- Ask how to use a library API as pinned in your project
- Get the exact signature of a function in your installed version
- Compare docs between two installed versions of a library
- Check what breaks before upgrading a framework
- Read docs for private internal packages

## Install

### Claude Code (Terminal)

```sh
claude mcp add lockdocs -- npx -y @sylphx/lockdocs
```

### Claude Desktop (claude_desktop_config.json)

```json
{
  "mcpServers": {
    "lockdocs": {
      "command": "npx",
      "args": [
        "-y",
        "@sylphx/lockdocs"
      ]
    }
  }
}
```

### Cursor (~/.cursor/mcp.json)

```json
{
  "mcpServers": {
    "lockdocs": {
      "command": "npx",
      "args": [
        "-y",
        "@sylphx/lockdocs"
      ]
    }
  }
}
```

### VS Code (.vscode/mcp.json)

```json
{
  "servers": {
    "lockdocs": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@sylphx/lockdocs"
      ]
    }
  }
}
```

### Windsurf (~/.codeium/windsurf/mcp_config.json)

```json
{
  "mcpServers": {
    "lockdocs": {
      "command": "npx",
      "args": [
        "-y",
        "@sylphx/lockdocs"
      ]
    }
  }
}
```

### Other clients (your client's MCP settings (most use this shape))

```json
{
  "mcpServers": {
    "lockdocs": {
      "command": "npx",
      "args": [
        "-y",
        "@sylphx/lockdocs"
      ]
    }
  }
}
```

## Tools

- `resolve`: Shows which package versions are pinned and whether their docs are available.
- `docs`: Answers a question from docs, optionally scoped to a package.
- `api`: Returns the exact signature and doc comment for a symbol.

## FAQ

### Does it need an account or API key?

No. It runs locally with no account, quota or key, under the MIT licence.

### Which ecosystems does it cover?

npm, PyPI, crates.io and Go.

### What does Pro add?

Full upgrade reports and docs for private package sources; a free preview still gives counts and a sample.

### How do I install it?

Run npx -y @sylphx/lockdocs setup to add it to detected clients.

### Is lockdocs free?

lockdocs has a free plan, with paid plans for more usage or features.

### How do I add lockdocs to Claude Code?

Run this command in your terminal: claude mcp add lockdocs -- npx -y @sylphx/lockdocs

### What are the best alternatives to lockdocs?

The closest alternatives to lockdocs are REA, Codebase Memory, GitHub, Serena MCP: the IDE for your agent and XERJ.

## Alternatives

- [REA](https://ai-powered.com/mcp/rea): REA is an open-source MCP server for developer tools.
- [Codebase Memory](https://ai-powered.com/mcp/codebase-memory): Codebase Memory is an open-source MCP server for knowledge and memory.
- [GitHub](https://ai-powered.com/mcp/github-2): GitHub is an open-source MCP server for developer tools.
- [Serena MCP: the IDE for your agent](https://ai-powered.com/mcp/serena-mcp-the-ide-for-your-agent): Serena MCP: the IDE for your agent is an open-source MCP server for developer tools.
- [XERJ](https://ai-powered.com/mcp/xerj): XERJ is an open-source MCP server for knowledge and memory.
- [Ouroboros](https://ai-powered.com/mcp/ouroboros): Ouroboros is an open-source MCP server for developer tools.
- [Claude Code Ultimate Guide](https://ai-powered.com/mcp/claude-code-ultimate-guide): Claude Code Ultimate Guide is an open-source MCP server for ai models and llm tooling.
- [Concord MCP](https://ai-powered.com/mcp/concord-mcp): Concord MCP is a freemium MCP server for developer tools.

---
Source: https://ai-powered.com/mcp/lockdocs
