Skip to main content

read and cache structured documents from remote for LLM agents

Project description

LLM API Scope (apiscope)

a tool for LLM agents to read and cache structured documents from remote.

install

use pipx for isolated installation:

pipx install llm-api-scope

how it works

apiscope fetches specifications from local files or remote URLs, caches them, and outputs structured JSON that agents can consume directly. no html parsing, no keyword ranking — just faithful extraction from the source document.

commands

run apiscope --help to see all available commands.

openapi

browse OpenAPI specifications with subcommands for discovering, listing, and describing operations.

aliases let you register frequently used specs once and reference them by short name. fetching is transparent — local copies are cached for fast repeat access, and a proxy can be configured for restricted networks.

rfc

read, search, and navigate RFC documents from the IETF.

the metadata index is mirrored once via rsync. individual text files are fetched on demand and cached locally. you can browse the table of contents, jump to a section (XML) or page (TXT), filter the index by status or source, and run keyword searches against fulltext content.

skill

output a combined command reference and strategy guide for AI agents.

run apiscope skill to get a single document that covers every subcommand and how they fit together. the strategy guide classifies commands into management and usage groups, lists prerequisites in ABNF (RFC 5234), and provides workflow patterns with requirement levels (RFC 2119).

agents read this output once at onboarding instead of running --help repeatedly.

repo

sync documentation directories from any git repository to a local cache.

register repositories by URL with a target subdirectory and a ref — a branch, tag, or commit. the sync command clones with shallow depth, blobless filter, and sparse checkout so only the needed tree and files come over the wire. extracted docs land in the cache under a stable hash path, and a configurable TTL avoids redundant re-fetches. provider-agnostic, zero auth.

future

  • read academic papers from arxiv
  • more formal document formats as the need arises

license

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm_api_scope-0.8.0.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_api_scope-0.8.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file llm_api_scope-0.8.0.tar.gz.

File metadata

  • Download URL: llm_api_scope-0.8.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.27.0 CPython/3.14.5 Linux/6.17.0-1018-azure

File hashes

Hashes for llm_api_scope-0.8.0.tar.gz
Algorithm Hash digest
SHA256 39ca628f8b04602cfe991471c89a20aee3a03be14a75b2a0839245fd6095a7de
MD5 0bdd7fd0cb3b1de0e51d6fb5cfec1f4e
BLAKE2b-256 e64804449ff5f1bb22d9cb427580c26c2a77d7598d509f8ea2d085b06a0c8a70

See more details on using hashes here.

File details

Details for the file llm_api_scope-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: llm_api_scope-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 30.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.27.0 CPython/3.14.5 Linux/6.17.0-1018-azure

File hashes

Hashes for llm_api_scope-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c73674ea507613543cecde4596cc700d24c1f6d24e7570c834ce142d2e5efea0
MD5 29db20cef34cdf05d0fe223b95cd50ed
BLAKE2b-256 7a370858df3d28cd5451a07f44a4dc6b8cbffb8b450d05991b370094a951ac3d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page