@common-agent/agentdoc 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Jeff Schneider
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,4 @@
1
+ Common Agent reference implementation in TypeScript
2
+ Copyright 2026 Jeff Schneider
3
+
4
+ This product is licensed under the Apache License, Version 2.0 (LICENSE).
package/README.md CHANGED
@@ -1,3 +1,143 @@
1
- # Temporary Holding Version
1
+ # AgentDoc
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ An AgentDoc is one document that says what an agent is, what it offers and
4
+ what it refuses. It is built only from what the agent itself publishes, every
5
+ line says where it came from, and anything the agent has not said is listed as
6
+ not stated.
7
+
8
+ This package makes, publishes and checks AgentDocs. It implements Chapter 9
9
+ of the Common Agent Specification. Read more at https://agentdoc.net.
10
+
11
+ ## Make one for your agent
12
+
13
+ If your agent speaks A2A, it already serves an agent card. Point the tool at
14
+ your agent's address:
15
+
16
+ npx @common-agent/agentdoc build https://your-agent.example
17
+
18
+ It reads the card at `/.well-known/agent-card.json` (or the older
19
+ `/.well-known/agent.json`) and writes two files:
20
+
21
+ agentdoc-out/.well-known/agentdoc.json the AgentDoc, for programs
22
+ agentdoc-out/agentdoc.html the same document as a page for people
23
+
24
+ You can also give it a card file instead of an address:
25
+
26
+ npx @common-agent/agentdoc build ./agent-card.json
27
+
28
+ ## Publish the two files
29
+
30
+ Put both files on your agent's own site, so these addresses serve them:
31
+
32
+ https://your-agent.example/.well-known/agentdoc.json
33
+ https://your-agent.example/agentdoc.html
34
+
35
+ The JSON sits beside your agent card, so anyone who has your agent's address
36
+ can find it. Build again whenever your card changes. An AgentDoc says when it
37
+ was built, and an old one is out of date, not wrong.
38
+
39
+ ## Add a signed Descriptor
40
+
41
+ A card says where your agent is and what skills it lists. It does not say
42
+ whom the agent acts for, what it refuses, or what it needs. A Descriptor
43
+ does, and your signature on it lets anyone check that it is your agent's own
44
+ statement. Three commands:
45
+
46
+ npx @common-agent/agentdoc init https://your-agent.example
47
+ npx @common-agent/agentdoc keygen
48
+ npx @common-agent/agentdoc sign agent-descriptor.json --key agent.key
49
+
50
+ `init` drafts `agent-descriptor.json` from your card. It marks every value it
51
+ had to guess, and every member you must fill in, under `_draft` at the top of
52
+ the file. Read each one, fix what is wrong, fill in what is missing (whom the
53
+ agent acts for, and what it refuses), then delete `_draft`.
54
+
55
+ `keygen` makes your agent's signing key. It writes the secret to `agent.key`,
56
+ readable only by you, and prints the public key. Keep that file secret and out
57
+ of version control.
58
+
59
+ `sign` binds the Descriptor to your key and signs it. It refuses while a guess
60
+ is unchecked or a required member is missing, and it says which.
61
+
62
+ Publish the signed file exactly as written at
63
+ `https://your-agent.example/.well-known/agent-descriptor.json`, then run
64
+ `build` again. The new AgentDoc cites your Descriptor by the digest of its
65
+ bytes, says its signature was verified, and fills the sections the card could
66
+ not.
67
+
68
+ ## Check one
69
+
70
+ npx @common-agent/agentdoc check https://your-agent.example/.well-known/agentdoc.json
71
+ npx @common-agent/agentdoc check agentdoc.json --fetch-sources
72
+
73
+ `check` runs the checks of Section 9.10 and prints each problem it finds.
74
+ With `--fetch-sources` it also fetches every source the document lists,
75
+ checks each digest, and looks for each fact in the sources its section cites.
76
+ It exits 0 when the AgentDoc passes, 1 when it does not, and 2 when it cannot
77
+ read it.
78
+
79
+ ## What it reads
80
+
81
+ | Source | Where it comes from | What it fills |
82
+ |---|---|---|
83
+ | The A2A agent card | `/.well-known/agent-card.json`, or a file | who it is, how to reach it, what it lists |
84
+ | The Descriptor | `/.well-known/agent-descriptor.json`, or `--descriptor` | whom it acts for, its offerings, what it refuses, what it reaches and keeps |
85
+ | Signed terms | the card's terms extension, or `--terms` | prices, where content is processed, how long it is kept |
86
+ | Evaluation records | `--eval-record` | which offerings and questions were confirmed or failed |
87
+ | Attestations | `--attestation` | what others published about it |
88
+
89
+ It verifies each signature it can and records the result per source:
90
+ `verified`, `unsigned`, `failed` or `not_checked`. A Descriptor or terms whose
91
+ signature fails are listed and not used. Nothing the sources do not say is
92
+ ever filled in. It goes in `not_stated` instead.
93
+
94
+ It never says how much of an agent can be checked from the inside
95
+ (`shape.visibility`), because that needs deployment records it does not read.
96
+ That member is always named as not stated.
97
+
98
+ ## Use it from code
99
+
100
+ ```ts
101
+ import { assemble, check, render } from "@common-agent/agentdoc";
102
+
103
+ const doc = await assemble({ address: "https://your-agent.example" });
104
+ const report = await check(doc);
105
+ const page = render(doc);
106
+ ```
107
+
108
+ `assemble` also takes `card`, `descriptor`, `terms`, `attestations` and
109
+ `evalRecords` directly, and a `fetch` to use. With `package` (a package's
110
+ `plugin.json`) and its draft `descriptor`, it writes a package AgentDoc, which
111
+ describes what any agent installed from that package will declare.
112
+
113
+ The JSON Schema is in this package at `schema/agentdoc-v1.schema.json`, and
114
+ at https://agentdoc.net/schema/agentdoc-v1.json.
115
+
116
+ ## The checks
117
+
118
+ `check` reports each finding with one of these rule ids, which every Common
119
+ Agent checker shares:
120
+
121
+ `sources-exist`, `section-has-source`, `source-digest`, `fact-in-source`,
122
+ `no-summary-grade`, `visibility-supports-claim`, `decided-by-rule`,
123
+ `sells-scope`, `open-offering-members`, `open-ended-no-claim`,
124
+ `assembled-at`, `fetched-at`, `not-stated-complete` and `no-default`.
125
+
126
+ The twelve that read the document alone agree with the Common Agent
127
+ Standards' conformance cases (`common-agent/conformance/agentdoc/`), which
128
+ this package's tests carry. A finding at level `warn` is something Chapter 9
129
+ asks for beyond those cases, and it never makes a document fail.
130
+
131
+ ## Files
132
+
133
+ | File | What it holds |
134
+ |---|---|
135
+ | `index.ts` | The public face |
136
+ | `assemble.ts` | The assembler, card first |
137
+ | `check.ts` | The checks of Section 9.10 |
138
+ | `render.ts` | The page |
139
+ | `signatures.ts` | The signature checks, the key and signing |
140
+ | `descriptor.ts` | The draft Descriptor from a card, and what signing needs |
141
+ | `paths.ts` | How `not_stated` paths are read |
142
+ | `types.ts` | The AgentDoc and the other shapes |
143
+ | `cli.ts`, `bin.ts` | The command line tool, `common-agent-doc` |
@@ -0,0 +1,36 @@
1
+ import type { AgentDoc, AgentDocSection, AssembleInput } from "./types.js";
2
+ /** Where an A2A card is served, newest name first. */
3
+ export declare const CARD_PATHS: readonly ["/.well-known/agent-card.json", "/.well-known/agent.json"];
4
+ /** Where a subject serves its Descriptor (Section 6.7). */
5
+ export declare const DESCRIPTOR_PATH = "/.well-known/agent-descriptor.json";
6
+ /** Where a subject serves its AgentDoc (Section 9.2). */
7
+ export declare const AGENTDOC_PATH = "/.well-known/agentdoc.json";
8
+ /** The card extension that commits to signed terms (Agent SoW's a2a-terms). */
9
+ export declare const TERMS_EXTENSION = "https://agentsow.com/extensions/a2a-terms/v1";
10
+ /** Where a declared interface's machine-readable definition is looked up, by name. */
11
+ export declare const INTERFACE_REGISTRY = "https://agentroles.ai/interfaces/";
12
+ /** What an open-ended offering never carries: any statement of what it can do (Section 9.5). */
13
+ export declare const OPEN_ENDED_CLAIMS: string[];
14
+ /** Why nothing could be assembled, in plain words. */
15
+ export declare class AssembleError extends Error {
16
+ constructor(message: string);
17
+ }
18
+ /** An AgentDoc and what the assembler noticed on the way: plain sentences for a person, never part of the document. */
19
+ export interface Assembled {
20
+ doc: AgentDoc;
21
+ notes: string[];
22
+ }
23
+ /** Assemble an AgentDoc. */
24
+ export declare function assemble(input: AssembleInput): Promise<AgentDoc>;
25
+ /** The places a card may be, for an address: the address itself when it names a JSON file, else the well-known paths under it and under its origin. */
26
+ export declare function cardCandidates(address: string): string[];
27
+ /** Assemble an AgentDoc, with plain notes on what the assembler found on the way. */
28
+ export declare function assembleWithNotes(input: AssembleInput): Promise<Assembled>;
29
+ /**
30
+ * The paths a document names in `not_stated`: every section nobody sourced,
31
+ * and every member Section 9 says a reader must be told is missing.
32
+ */
33
+ export declare function notStatedOf(sections: Record<string, AgentDocSection>, opts: {
34
+ pkg: boolean;
35
+ card: boolean;
36
+ }): string[];