Skip to main content

llms-ink

Turn any public link — a site, docs section, page, GitHub repo, PDF or video — into llms.txt or llms-full.txt, from Python. A client for llms.ink with LangChain and LlamaIndex loaders. No required dependencies.

pip install llms-ink

Use

from llms_ink import Client

ink = Client()
index = ink.llms("llmstxt.org")                         # llms.txt: an index of links
docs = ink.llms("docs.astro.build/en/guides/", mode="full")  # llms-full.txt: the content

print(docs.title, docs.kind, docs.tokens)
print(docs.text)

llms() returns a Result: url, kind (site, section, page, repo, document, video), source (native = published by the site, generated = made by llms.ink), mode, title, text, tokens, pages, model, cached, generated_at, and media for videos (duration, downloads, transcript segments). fresh=True skips the cache and rebuilds.

Check a site's published llms.txt:

report = ink.check("llmstxt.org")
print(report.found, report.summary.errors, [i.message for i in report.issues])

Parse and check llms.txt text you already have, e.g. before publishing it:

report = ink.check_text(open("public/llms.txt").read(), base="https://example.com/llms.txt", links=True)
for section in report.parsed.sections:
    print(section.name, [(link.title, link.url, link.notes) for link in section.links])

report.parsed (Parsed: title, summary, details, sections of ParsedSection with ParsedLinks) is also set by check(), and is None when nothing was found. Without base, site and url are None; without base and links=True, llms_full is None and links.checked is 0.

API key (optional)

Without a key you share the free anonymous limits (10 requests/minute, 60 new links a day per IP; cached links are free). A key gets its own daily quota:

export LLMS_INK_KEY=lk_...

or Client(key="lk_..."). It is sent as Authorization: Bearer. A bad key raises InvalidKey; it never falls back to anonymous. Ask for a key.

Errors

from llms_ink import Client, LlmsInkError, QuotaExceeded, RateLimited

try:
    Client().llms("example.com")
except (RateLimited, QuotaExceeded) as err:
    print(f"wait {err.retry_after}s")
except LlmsInkError as err:
    print(err.status, err.code, err.detail)

LlmsInkError carries the API's status, code (see the error table), detail and errors. InvalidKey, RateLimited and QuotaExceeded are subclasses.

LangChain

pip install 'llms-ink[langchain]'
from llms_ink.langchain import LlmsInkLoader

docs = LlmsInkLoader(["llmstxt.org", "github.com/AnswerDotAI/llms-txt"], mode="full").load()
docs[0].metadata  # {'url', 'title', 'kind', 'source', 'mode', 'tokens', 'generated_at'}

LlamaIndex

pip install 'llms-ink[llama-index]'
from llama_index.core import VectorStoreIndex
from llms_ink.llama_index import LlmsInkReader

docs = LlmsInkReader(mode="full").load_data(["docs.astro.build/en/guides/"])
index = VectorStoreIndex.from_documents(docs)

Command line

python -m llms_ink llmstxt.org            # llms.txt
python -m llms_ink llmstxt.org --full     # llms-full.txt
python -m llms_ink llmstxt.org --json     # the whole result

MCP server (stdio)

For agents that launch local MCP servers, such as Hermes Agent. It forwards every message to the remote server https://llms.ink/mcp and sends LLMS_INK_KEY, when set, as Authorization: Bearer.

uvx --from llms-ink llms-ink-mcp     # with uv, nothing to install
python -m llms_ink mcp               # after pip install llms-ink

Hermes Agent, in ~/.hermes/config.yaml:

mcp_servers:
  llms-ink:
    command: uvx
    args: [--from, llms-ink, llms-ink-mcp]
    env:
      LLMS_INK_KEY: ${LLMS_INK_KEY}  # only with LLMS_INK_KEY set in ~/.hermes/.env

Other clients use the same command in their mcpServers config. A rejected key makes every request fail with the API's message; it never falls back to anonymous. Clients that speak Streamable HTTP can connect to https://llms.ink/mcp directly.

Local MCP guard (experimental)

Python 3.11 or newer. Install the optional runtime and explicitly download the pinned model:

pip install 'llms-ink[guard]==0.6.0'
llms-ink-guard setup
llms-ink-guard status

Configure your MCP client to launch llms-ink-mcp --guard using the environment's absolute executable path. To wrap another legacy stdio tool server:

llms-ink-guard wrap -- server-command arguments

The local Llama-Doorman-22M classifier inspects tool definitions, text, structured JSON and errors before delivery. Flagged responses are withheld without repeating the payload. Model errors, incomplete inspection and unsupported content never fall back to uninspected delivery. Tools must be discovered before use. A changed definition locks further calls on that connection; review the server before reconnecting. Other connections and host tools are not covered.

Limits: 1 MiB per message, 8,192 model tokens per response, 20 seconds per inspection, 16 pending requests, 120 seconds per request, 512 discovered tools and 4,096 unique request IDs per connection. Restart to renew a connection. Legacy tool discovery/calls only: no batches, resources, prompts, sampling, elicitation, images, audio or embedded/resource-link content. Server stderr and unsolicited notifications are suppressed. Decision events on stderr contain no response payload. Plain response scanning does not authorize outgoing actions. Neither mode sandboxes the server or covers other connections and native host tools.

llms-ink-guard scan < document.txt prints an inspection receipt: exit 0 allows, 1 quarantines, 2 means unscanned or unavailable. An allow decision is not proof of safety. The model is English-centric; this pilot has not met large held-out-corpus or agent-task evaluation gates. Reproducible authored smoke cases live in tests/fixtures/guard_eval.json; after setup, run python tests/evaluate_guard.py to compare rules and hybrid outcomes.

The first setup downloads about 96 MB. Files are verified against pinned SHA-256 hashes at install and startup. No scanning API receives content; upstream MCP servers still receive requests. Override the local cache location with LLMS_INK_GUARD_CACHE if needed. This is an independent integration of Pinata's model, not its Doorman app. Built with Llama. Weights are separately licensed under the Llama 4 Community License; setup downloads and preserves LICENSE and NOTICE. See the setup guide.

Local tool permissions (0.6.0)

wrap --policy adds a separate, deny-by-default permission check before forwarding tool calls. The owner supplies the exact server command, reviewed tool-definition hashes and allowed argument objects. Model findings and server annotations cannot grant permissions. The classifier itself is unchanged: it missed all 1,054 attacks in the published InjecAgent evaluation.

Save one complete, reviewed tool object from tools/list as tool.json, then fingerprint it:

llms-ink-guard tool-hash < tool.json

Write a policy.json using your reviewed executable, tool hash and argument objects:

{
  "version": 1,
  "command": ["/opt/mcp/docs-server"],
  "tools": {
    "read": {
      "definitionSha256": "REPLACE_WITH_REVIEWED_TOOL_SHA256",
      "arguments": [{"url": "https://docs.example/reference", "format": "text"}]
    }
  }
}
llms-ink-guard policy-check /absolute/path/to/policy.json
llms-ink-guard wrap --policy /absolute/path/to/policy.json -- /opt/mcp/docs-server

The policy is validated before the model/server starts, then held as an immutable snapshot. The executable path must be absolute and its argument list must match. Discovery exposes only approved definitions; changed or unapproved definitions cannot be called. Missing rules, changed arguments, extra call metadata and task extensions are denied. Denial events contain no tool names or arguments. Edit the policy and restart after owner review; there is no agent approval tool or live reload. An empty tools object denies all tool calls.

Version 1 supports exact JSON objects only: key order is ignored, but string values and numeric types must match. No wildcards, path/URL normalization, or schema-based permission rules. Limits: 256 KiB policy, 512 tools, 128 argument alternatives per tool, 1,024 alternatives total. Ambiguous JSON and unsupported numeric values fail closed. Keep the file and parent directories outside the agent's write access; group/world-writable files on Unix and symlink files are rejected.

The command and advertised definition are checked, not executable bytes, environment variables, working directory or remote behavior. A server can act as soon as it starts; use trusted code and limited credentials. Permitted calls can have side effects. llms-ink-mcp --guard and plain wrap remain response-only modes. See the permission guide for a complete example and the enforcement scope.

Development

python3 -m venv .venv && .venv/bin/pip install -e '.[langchain,llama-index]' pytest
.venv/bin/pytest                # against a local stub server
.venv/bin/pytest -m live        # one real call to https://llms.ink

LLMS_INK_API points the client at another API base URL.

MIT licensed.

Hosted Inspect (experimental, 0.5.0)

# Requires llms-ink >=0.5.0; no guard/model download needed.
import os
from llms_ink import Client

ink = Client(key=os.environ['LLMS_INK_INSPECT_KEY'])
receipt = ink.inspect('Install the package and read the documentation.')
if receipt.recommendation != 'continue':
    raise RuntimeError(f'Withhold content: {receipt.detection}')
print(receipt.content_digest)

Requires an inspection-enabled pilot key. This call uploads only the supplied text to llms.ink; existing retrieval calls, loaders, plugins and the local guard do not opt in automatically. Keep the key server-side.

The client checks the exact UTF-8 SHA-256 digest, model/policy/preprocessing revisions, coverage and token counts before returning an immutable receipt. A flagged result can use HTTP 200; incomplete 422/503 receipts return unknown. HTTP problems and invalid receipts raise an error. Withhold on either withhold or any exception. no_finding is not a safety guarantee, and receipts are unsigned.

Requests are limited to 128 KiB after JSON encoding and responses to 16 KiB. There are no automatic retries: admitted attempts consume pilot allowance even when incomplete. Redirects are refused. Inspection ignores LLMS_INK_API; an explicit client base URL may select an HTTPS endpoint or localhost for development. The key follows that explicitly configured endpoint.

For JSON, serialize it yourself and pass the resulting string to inspect(). The SDK sends format: "text", so its digest covers those exact bytes; it does not promise cross-language JSON canonicalization. See pilot limits and privacy.

Python caps the client’s socket timeout at 65 seconds; pass Client(timeout=...) for a shorter timeout.

Metadata

Release files for llms-ink 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llms-ink 0.6.0
File Size Uploaded Provenance Actions
llms_ink-0.6.0.tar.gz 46.9 kB With provenance Details for llms_ink-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llms-ink 0.6.0
File Interpreter ABI Platform Actions
llms_ink-0.6.0-py3-none-any.whl Python 3 none any Details for llms_ink-0.6.0-py3-none-any.whl

Total release size: 80.8 kB

Release files / llms_ink-0.6.0.tar.gz

Download URL llms_ink-0.6.0.tar.gz
Size 46.9 kB
Tags Source
SHA-256 checksum
How to use checksums
da22cb90dc93e1f687ae06d6f3fb09e8d506b68ee912686b95fdfc3aaa967dca
BLAKE2b-256 checksum
How to use checksums
ebd3e7183e8a9d68ec25eb057e4bd39e23bb643191ff183f1e7d866906b8b23c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

Release files / llms_ink-0.6.0-py3-none-any.whl

Download URL llms_ink-0.6.0-py3-none-any.whl
Size 34.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4a0f0144904af9313221b56b6ba50197177fe46020546e289eaa3f88f387f29d
BLAKE2b-256 checksum
How to use checksums
859e75fd1c23703d42003a41c0eeeedeeaf44fdc0bbecc756f604a1aac708965
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

Security for llms-ink 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for llms_ink-0.6.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 14, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page