-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathllms.txt
More file actions
71 lines (50 loc) · 11.5 KB
/
Copy pathllms.txt
File metadata and controls
71 lines (50 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Jentic One
> Jentic One is a self-hosted execution layer for AI agents. You register the APIs an agent may use and store each credential once; the agent then calls those APIs through a credential-injecting Broker, so your agent never sees your keys. Apache-2.0, public beta, runs on a laptop, a VM or Kubernetes.
What an agent can do once an instance is running:
- Discover operations across thousands of APIs and call them without an SDK, a client library or a key per service.
- Reach private and internal APIs. Register your own OpenAPI description and the same credential custody, per-agent permissions and audit trail apply to services that exist only inside your network.
- Hold its own identity. Each agent registers an Ed25519 keypair through dynamic client registration (RFC 7591/7592), so access is granted per agent rather than per machine.
- Work inside a scope. An agent reaches only the operations it has been approved for, and asking for more is a reviewable request rather than a silent widening.
- Leave a trail. Every brokered call is recorded as an execution record; control-plane actions land in an append-only audit log.
What it does not do. Jentic One bounds what a mistaken or compromised agent can reach. It does not make an agent correct or reliable, and it does not remove the judgment call about which operations an agent should be allowed to touch at all.
Agents integrate three ways, all documented below (MCP has two transports, so four paths in all). First: through the `jentic` CLI and the skill it generates. Second: over MCP, either the CLI's local stdio server (`jentic mcp`) or the deployment's own Streamable HTTP `/mcp` endpoint, which is config-gated and off by default (see [docs/guides/mcp-http-endpoint.md](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/guides/mcp-http-endpoint.md)). Third: over plain HTTP against the deployment's own API.
If you are an agent asked to **install or operate** Jentic One, start with the agent runbooks — they are written for you to execute directly, with the human-approval gates marked. The set: [install](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/install.md) (stand up the app, broker and database with Docker), [operate](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/operate.md) (start/stop/upgrade/uninstall), [use](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/use.md) (the discover → access → execute loop), [troubleshoot](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/troubleshoot.md) (symptom-keyed recoveries when a step fails), [harden](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/harden.md) (read before storing a real credential).
Jentic One typically runs on one machine and the agent on another. On the host machine, follow the install runbook above (or the human-facing [installation guides](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/installation/README.md)). On each agent machine, install only the `jentic` binary ([CLI install guide](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/installation/cli.md)) and run `jentic setup --url <deployment URL>` to create the agent identity against that deployment and install the agent skill. `jentic register` is the registration-only path — identity only, no skills. When `--url` is omitted, both commands fall back to the configured base URL or `http://127.0.0.1:8000`. Both block on a human approving the agent in the deployment's console.
Keep the agent off the machine that runs Jentic One. An agent running as the same OS user can read the credential database and the encryption key directly off disk whatever the API-level controls say, so keep them on separate machines. The hardening guide below sets out the tiers; read it before pointing an instance at a real credential.
A running instance serves its own `/llms.txt` and `/.well-known/llms.txt`, generated with that deployment's base URL and the onboarding sequence for an agent already pointed at it. Once you have an instance, prefer that document over this one for anything an agent does at runtime. This file covers evaluating and installing.
## Install
- [Agent install runbook](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/install.md): the install an agent executes directly — preflight, config and compose generation, migrations, first admin (human gate), agent registration (human gate), verification. Companions: [operate](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/operate.md), [troubleshoot](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/troubleshoot.md), [harden](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/agent/harden.md).
- [CLI binaries](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/installation/cli.md): downloading and cosign-verifying the released `jentic` and `jenticctl` binaries for every platform, or installing via Homebrew/winget/Scoop.
- [Installation overview](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/installation/README.md): the human-facing guides — Docker with external Postgres, systemd, Helm, AWS — plus artifact verification and air-gapped transfer.
- [CLI reference](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/cli/README.md): what `jenticctl` and `jentic` each own, the full command groups, and the agent loop of `search`, `inspect`, `execute`.
- [Build & deploy architecture](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/deploy/README.md): how the images, Helm charts and Terraform layouts are built — one image, runtime surfaces, digest pins, multi-arch.
- [AWS Marketplace install](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/installation/aws-marketplace.md): running the listed product on EKS — storage and IRSA prerequisites, the zero-touch Helm install, upgrades, and how the runtime license check behaves.
- [Local development setup](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/development/local-setup.md): running from source with `make install`, `make dev` and `make check`.
## Security
- [Hardening guide](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/security/README.md): the threat model and a tiered set of deployment postures, from trying it out to handling production credentials. Explains why the network guarantee holds and the same-host, same-user case does not.
- [Same-host setups](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/security/same-host/README.md): the options for the case where the agent must share a machine with the instance, and what each one actually buys.
- [How credential resolution works](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/guides/credentials-and-toolkits.md): how the agent never holds a secret — encrypted storage, credential providers, server-side resolution and injection, and the audit trail.
- [SECURITY.md](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/SECURITY.md): supported versions and how to report a vulnerability.
## How it works
- [README](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/README.md): the architecture diagram. An App control plane (Registry, Control, Admin and Auth surfaces) and a stateless Broker data plane over PostgreSQL or SQLite.
- [Architecture overview](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/architecture/README.md): the next level down — the five surfaces (including the auth surface), runtime process shapes, the broker's execution pipeline, the three-database data model, and identity/authorization. Start here to understand the codebase.
- [Endpoint and authorization reference](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/reference/endpoints.md): every HTTP endpoint with the scopes it requires. This is the authoritative source for authorization, because the OpenAPI documents model authentication only.
- [Configuration reference](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/reference/config.md): every configuration key with its type, default, and `JENTIC__*` environment variable, generated from the config model and drift-guarded in CI.
- [Control plane OpenAPI](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/openapi/control/control.openapi.yaml) and [Broker OpenAPI](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/openapi/broker/broker.openapi.yaml): the two machine-readable API descriptions, for calling an instance over raw HTTP instead of through the CLI.
- [Agent skill](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/skills/jentic/SKILL.md): the instructions installed into an agent runtime by `jentic skill init` (or `jentic setup`), describing the identity, discover, request access, execute loop.
- [Context and configuration](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/development/context-and-config.md): how a deployment is configured, and what an agent's execution context carries.
- [Overlays](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/guides/overlays.md): correcting or adapting an imported API description without editing the original.
## APIs to run against
- [Jentic API Directory](https://github.com/jentic/jentic-public-apis): open-source directory of machine-readable API descriptions, released under CC0. Thousands of standardized OpenAPI documents plus Arazzo workflows, importable straight into a Jentic One instance.
- [Directory on the web](https://jentic.com/apis): the same APIs as browsable pages, with an AI-readiness score for each.
## Project
- [CONTRIBUTING.md](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/CONTRIBUTING.md): development workflow, commit conventions and the checks a change has to pass.
- [Issues](https://github.com/jentic/jentic-one/issues) and [Discussions](https://github.com/jentic/jentic-one/discussions): bug reports and feature requests, and questions about running it.
- [SUPPORT.md](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/SUPPORT.md): what community support covers for a self-hosted deployment.
- [Releases](https://github.com/jentic/jentic-one/releases) and [CHANGELOG.md](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/CHANGELOG.md): what shipped in each version.
- [LICENSE](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/LICENSE): Apache-2.0.
## Optional
- [Connect an agent](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/guides/connecting-agents.md): the four integration paths in one place, and how the self-hosted product differs from the Jentic cloud platform — the two are easy to conflate and share no state, so don't copy integration instructions from one into the other.
- [Extending Jentic One](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/docs/development/extending-jentic-one.md): adding a surface or a capability to the codebase itself.
- [VERSIONING.md](https://raw.githubusercontent.com/jentic/jentic-one/refs/heads/main/VERSIONING.md): what the version number promises while the project is in public beta.
- [Jentic documentation](https://docs.jentic.com/): the documentation site. A deployment also serves its own interactive API reference at `/docs`, generated from code.