@agent-workspace/core 0.2.0 → 0.2.1
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/README.md +81 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# @agent-workspace/core
|
|
2
|
+
|
|
3
|
+
Core types, constants, and JSON schemas for the [Agent Workspace Protocol](https://github.com/marcoloco23/awp).
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @agent-workspace/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## What's Inside
|
|
12
|
+
|
|
13
|
+
- **TypeScript types** for all AWP file frontmatter (`IdentityFrontmatter`, `SoulFrontmatter`, `MemoryDailyFrontmatter`, `ArtifactFrontmatter`, etc.)
|
|
14
|
+
- **Constants** — file paths, version strings, type registries
|
|
15
|
+
- **JSON Schemas** — bundled validation schemas for every AWP file type
|
|
16
|
+
|
|
17
|
+
Zero runtime dependencies. Types + constants only.
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type {
|
|
23
|
+
IdentityFrontmatter,
|
|
24
|
+
SoulFrontmatter,
|
|
25
|
+
ArtifactFrontmatter,
|
|
26
|
+
WorkspaceManifest,
|
|
27
|
+
} from "@agent-workspace/core";
|
|
28
|
+
|
|
29
|
+
import {
|
|
30
|
+
AWP_VERSION,
|
|
31
|
+
SMP_VERSION,
|
|
32
|
+
REQUIRED_FILES,
|
|
33
|
+
ARTIFACTS_DIR,
|
|
34
|
+
getSchemaPath,
|
|
35
|
+
} from "@agent-workspace/core";
|
|
36
|
+
|
|
37
|
+
// Load a bundled JSON schema
|
|
38
|
+
const schemaPath = getSchemaPath("identity");
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Schemas
|
|
42
|
+
|
|
43
|
+
Bundled schemas are accessible via the `@agent-workspace/core/schemas/*` export:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import { getSchemaPath } from "@agent-workspace/core";
|
|
47
|
+
|
|
48
|
+
// Returns the absolute path to the schema file
|
|
49
|
+
const path = getSchemaPath("knowledge-artifact");
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Available schemas: `identity`, `soul`, `user`, `operations`, `tools`, `heartbeat`, `memory-daily`, `memory-longterm`, `knowledge-artifact`, `workspace`.
|
|
53
|
+
|
|
54
|
+
## Types
|
|
55
|
+
|
|
56
|
+
| Type | File |
|
|
57
|
+
|------|------|
|
|
58
|
+
| `IdentityFrontmatter` | `IDENTITY.md` |
|
|
59
|
+
| `SoulFrontmatter` | `SOUL.md` |
|
|
60
|
+
| `UserFrontmatter` | `USER.md` |
|
|
61
|
+
| `OperationsFrontmatter` | `AGENTS.md` |
|
|
62
|
+
| `ToolsFrontmatter` | `TOOLS.md` |
|
|
63
|
+
| `HeartbeatFrontmatter` | `HEARTBEAT.md` |
|
|
64
|
+
| `MemoryDailyFrontmatter` | `memory/YYYY-MM-DD.md` |
|
|
65
|
+
| `MemoryLongtermFrontmatter` | `memory/longterm.md` |
|
|
66
|
+
| `ArtifactFrontmatter` | `artifacts/<slug>.md` |
|
|
67
|
+
| `WorkspaceManifest` | `.awp/workspace.json` |
|
|
68
|
+
|
|
69
|
+
## Part of AWP
|
|
70
|
+
|
|
71
|
+
This package is part of the [Agent Workspace Protocol](https://github.com/marcoloco23/awp) monorepo:
|
|
72
|
+
|
|
73
|
+
| Package | Description |
|
|
74
|
+
|---------|-------------|
|
|
75
|
+
| **@agent-workspace/core** | Types, constants, JSON schemas |
|
|
76
|
+
| [@agent-workspace/cli](https://www.npmjs.com/package/@agent-workspace/cli) | CLI tool |
|
|
77
|
+
| [@agent-workspace/mcp-server](https://www.npmjs.com/package/@agent-workspace/mcp-server) | MCP server |
|
|
78
|
+
|
|
79
|
+
## License
|
|
80
|
+
|
|
81
|
+
Apache-2.0
|