@eventcatalog/core 3.41.0 → 3.41.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/dist/analytics/analytics.cjs +1 -1
- package/dist/analytics/analytics.js +2 -2
- package/dist/analytics/log-build.cjs +1 -1
- package/dist/analytics/log-build.js +3 -3
- package/dist/{chunk-TWFS6THS.js → chunk-6C2H2YLW.js} +1 -1
- package/dist/{chunk-DKFIEB24.js → chunk-GNLFCESR.js} +1 -1
- package/dist/{chunk-ZN3JKTWB.js → chunk-UGNBEYJJ.js} +1 -1
- package/dist/{chunk-QVJGIQYP.js → chunk-X5JM6SAH.js} +1 -1
- package/dist/{chunk-3R6TKNHG.js → chunk-Z5A2F2DN.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/development/components/components/04-agent-tools.md +43 -0
- package/dist/docs/development/guides/agents/01-introduction.md +43 -0
- package/dist/docs/development/guides/agents/02-adding-agents.md +152 -0
- package/dist/docs/development/guides/agents/03-adding-tools.md +92 -0
- package/dist/docs/development/guides/agents/04-model-metadata.md +96 -0
- package/dist/docs/development/guides/agents/_category_.json +11 -0
- package/dist/docs/development/guides/agents/adding-to-agents/01-messages.md +122 -0
- package/dist/docs/development/guides/agents/adding-to-agents/02-datastores.md +62 -0
- package/dist/docs/development/guides/agents/adding-to-agents/_category_.json +10 -0
- package/dist/docs/development/guides/agents/ownership/01-owners.md +67 -0
- package/dist/docs/development/guides/agents/ownership/_category_.json +11 -0
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/01-versioning.md +48 -0
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/02-changelog.md +40 -0
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/03-deprecating.md +41 -0
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/_category_.json +11 -0
- package/dist/docs/development/guides/domains/02-creating-domains/03-adding-services-to-domains.md +27 -0
- package/dist/docs/development/guides/flows/03-flow-nodes.md +30 -0
- package/dist/eventcatalog.cjs +1 -1
- package/dist/eventcatalog.js +5 -5
- package/dist/generate.cjs +1 -1
- package/dist/generate.js +3 -3
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/package.json +4 -4
- /package/dist/docs/development/components/components/{04-attachments.md → 05-attachments.md} +0 -0
- /package/dist/docs/development/components/components/{05-channel-information.md → 06-channel-information.md} +0 -0
- /package/dist/docs/development/components/components/{06-design.md → 07-design.md} +0 -0
- /package/dist/docs/development/components/components/{07-entitymap.md → 08-entitymap.md} +0 -0
- /package/dist/docs/development/components/components/{08-flow.md → 09-flow.md} +0 -0
- /package/dist/docs/development/components/components/{09-link.md → 10-link.md} +0 -0
- /package/dist/docs/development/components/components/{10-mermaid-file-loader.md → 11-mermaid-file-loader.md} +0 -0
- /package/dist/docs/development/components/components/{11-message-table.md → 12-message-table.md} +0 -0
- /package/dist/docs/development/components/components/{12-nodegraph.md → 13-nodegraph.md} +0 -0
- /package/dist/docs/development/components/components/{13-openapi.md → 14-openapi.md} +0 -0
- /package/dist/docs/development/components/components/{14-prompt.md → 15-prompt.md} +0 -0
- /package/dist/docs/development/components/components/{15-remote-schema.md → 16-remote-schema.md} +0 -0
- /package/dist/docs/development/components/components/{16-resource-group-table.md → 17-resource-group-table.md} +0 -0
- /package/dist/docs/development/components/components/{17-resource-link.md → 18-resource-link.md} +0 -0
- /package/dist/docs/development/components/components/{18-schema.md → 19-schema.md} +0 -0
- /package/dist/docs/development/components/components/{19-schema-viewer.md → 20-schema-viewer.md} +0 -0
- /package/dist/docs/development/components/components/{20-steps.md → 21-steps.md} +0 -0
- /package/dist/docs/development/components/components/{21-tabs.md → 22-tabs.md} +0 -0
- /package/dist/docs/development/components/components/{22-tiles.md → 23-tiles.md} +0 -0
- /package/dist/docs/development/components/components/{23-visibility.md → 24-visibility.md} +0 -0
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "../chunk-
|
|
4
|
-
import "../chunk-
|
|
3
|
+
} from "../chunk-UGNBEYJJ.js";
|
|
4
|
+
import "../chunk-6C2H2YLW.js";
|
|
5
5
|
import "../chunk-3DVHEVHQ.js";
|
|
6
|
-
import "../chunk-
|
|
6
|
+
import "../chunk-X5JM6SAH.js";
|
|
7
7
|
import "../chunk-5T63CXKU.js";
|
|
8
8
|
export {
|
|
9
9
|
log_build_default as default
|
package/dist/constants.cjs
CHANGED
package/dist/constants.js
CHANGED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 2
|
|
3
|
+
keywords:
|
|
4
|
+
- components
|
|
5
|
+
- agents
|
|
6
|
+
- agent tools
|
|
7
|
+
sidebar_label: AgentTools
|
|
8
|
+
title: AgentTools
|
|
9
|
+
description: Component for displaying the tools an agent can call in EventCatalog
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
13
|
+
|
|
14
|
+
<AddedIn version="3.41.0" />
|
|
15
|
+
|
|
16
|
+
The `<AgentTools/>` component renders a table of the tools an agent can call (MCP servers, REST APIs, internal search indexes, databases, and so on).
|
|
17
|
+
|
|
18
|
+
The component reads the `tools` array from the current agent's frontmatter, so it requires no props.
|
|
19
|
+
|
|
20
|
+
### Use case
|
|
21
|
+
|
|
22
|
+
- Display all the external capabilities an agent reaches out to at runtime.
|
|
23
|
+
- Show MCP server endpoints, REST APIs, and other integrations on the agent page.
|
|
24
|
+
|
|
25
|
+
**Basic Example**
|
|
26
|
+
|
|
27
|
+
```jsx /agents/OrderSupportAgent/index.mdx
|
|
28
|
+
<AgentTools />
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Output
|
|
32
|
+
|
|
33
|
+

|
|
34
|
+
|
|
35
|
+
### Props
|
|
36
|
+
|
|
37
|
+
The `<AgentTools/>` component takes no props — it reads the `tools` array from the current agent's frontmatter.
|
|
38
|
+
|
|
39
|
+
For details on the `tools` frontmatter shape, see [Agent tools](/docs/development/guides/agents/adding-tools).
|
|
40
|
+
|
|
41
|
+
### Support
|
|
42
|
+
|
|
43
|
+
The `<AgentTools/>` component is supported in agent pages only. If you add it to a service, message, or domain page, the catalog will display a warning and skip the table.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 1
|
|
3
|
+
keywords:
|
|
4
|
+
- EventCatalog agents
|
|
5
|
+
- AI agents
|
|
6
|
+
- LLM agents
|
|
7
|
+
- agent documentation
|
|
8
|
+
sidebar_label: What are agents?
|
|
9
|
+
title: Understanding agents
|
|
10
|
+
description: Document and govern AI agents alongside your services and events.
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
14
|
+
|
|
15
|
+
<AddedIn version="3.41.0" />
|
|
16
|
+
|
|
17
|
+
In EventCatalog, agents represent AI-powered components in your architecture. They sit alongside services, messages, domains, and flows as first-class catalog resources.
|
|
18
|
+
|
|
19
|
+
An agent typically wraps a large language model (LLM) and is given access to tools (MCP servers, APIs, databases) so it can take autonomous or semi-autonomous actions.
|
|
20
|
+
|
|
21
|
+

|
|
22
|
+
|
|
23
|
+
## Why document agents?
|
|
24
|
+
|
|
25
|
+
As AI agents take on real responsibilities in production systems they become part of your architecture whether or not they are documented.
|
|
26
|
+
|
|
27
|
+
Cataloging them gives your team:
|
|
28
|
+
|
|
29
|
+
- **Discoverability** — engineers and stakeholders can find what agents exist, what they do, and who owns them.
|
|
30
|
+
- **Model governance** — the `model` block captures which provider, model, and snapshot version the agent runs on so drift is visible in the catalog.
|
|
31
|
+
- **Tool transparency** — the `tools` array lists every external capability (MCP server, API, database) the agent can reach.
|
|
32
|
+
|
|
33
|
+
## Where agents live in your architecture
|
|
34
|
+
|
|
35
|
+
Agents can belong to a domain or subdomain, or sit at the root of your catalog alongside services. They participate in flows as first-class steps and appear in search, the sidebar, and the discover page.
|
|
36
|
+
|
|
37
|
+

|
|
38
|
+
|
|
39
|
+
## Finding agents in your catalog
|
|
40
|
+
|
|
41
|
+
Agents appear in the discover page alongside services, messages, domains, and flows. You can search, filter, and browse them the same way you would any other resource.
|
|
42
|
+
|
|
43
|
+

|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 2
|
|
3
|
+
keywords:
|
|
4
|
+
- EventCatalog agents
|
|
5
|
+
- AI agents
|
|
6
|
+
- creating agents
|
|
7
|
+
sidebar_label: Creating an agent
|
|
8
|
+
title: Creating agents
|
|
9
|
+
description: Creating and managing agents within EventCatalog.
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
13
|
+
|
|
14
|
+
<AddedIn version="3.41.0" />
|
|
15
|
+
|
|
16
|
+
Agents in EventCatalog are a great way to document AI-powered capabilities in your architecture.
|
|
17
|
+
|
|
18
|
+
You can also add [tools](/docs/development/guides/agents/adding-tools) and [model metadata](/docs/development/guides/agents/model-metadata) to your agents.
|
|
19
|
+
|
|
20
|
+
### What do agents look like in EventCatalog?
|
|
21
|
+
|
|
22
|
+

|
|
23
|
+
|
|
24
|
+
## Adding a new agent
|
|
25
|
+
|
|
26
|
+
To add a new agent, create a folder inside an `agents` directory with an `index.mdx` file.
|
|
27
|
+
|
|
28
|
+
- `/agents/{Agent Name}/index.mdx`
|
|
29
|
+
- (example `/agents/FraudReviewAgent/index.mdx`)
|
|
30
|
+
|
|
31
|
+
You can also place agents inside a domain or subdomain:
|
|
32
|
+
|
|
33
|
+
- `/domains/{Domain Name}/agents/{Agent Name}/index.mdx`
|
|
34
|
+
- (example `/domains/Payment/agents/FraudReviewAgent/index.mdx`)
|
|
35
|
+
- `/domains/{Domain Name}/subdomains/{Subdomain Name}/agents/{Agent Name}/index.mdx`
|
|
36
|
+
- (example `/domains/E-Commerce/subdomains/Payment/agents/FraudReviewAgent/index.mdx`)
|
|
37
|
+
|
|
38
|
+
_Here is an example of what an agent markdown file may look like._
|
|
39
|
+
|
|
40
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
41
|
+
---
|
|
42
|
+
# id of your agent, used for slugs and references in EventCatalog.
|
|
43
|
+
id: FraudReviewAgent
|
|
44
|
+
|
|
45
|
+
# Display name of the Agent, rendered in EventCatalog
|
|
46
|
+
name: Fraud Review Agent
|
|
47
|
+
|
|
48
|
+
# Version of the Agent
|
|
49
|
+
version: 0.0.1
|
|
50
|
+
|
|
51
|
+
# Short summary of your Agent
|
|
52
|
+
summary: |
|
|
53
|
+
Reviews risky payments, explains fraud signals, and recommends whether payment processing should continue.
|
|
54
|
+
|
|
55
|
+
# Optional owners, references teams or users
|
|
56
|
+
owners:
|
|
57
|
+
- dboyne
|
|
58
|
+
|
|
59
|
+
# Optional model metadata describing the LLM this agent runs on
|
|
60
|
+
model:
|
|
61
|
+
provider: OpenAI
|
|
62
|
+
name: gpt-4.1
|
|
63
|
+
version: "2025-04-14"
|
|
64
|
+
|
|
65
|
+
# Optional external tools the agent can call
|
|
66
|
+
tools:
|
|
67
|
+
- name: Risk profile lookup
|
|
68
|
+
type: mcp
|
|
69
|
+
icon: /icons/tools/datadog.svg
|
|
70
|
+
url: https://mcp.example.com/fraud/risk-profile
|
|
71
|
+
description: Retrieves transaction anomaly, device fingerprint, and fraud model signals.
|
|
72
|
+
|
|
73
|
+
# Optional messages this agent receives and it's version
|
|
74
|
+
receives:
|
|
75
|
+
- id: PaymentInitiated
|
|
76
|
+
version: 0.0.1
|
|
77
|
+
|
|
78
|
+
# Optional messages this agent sends and it's version
|
|
79
|
+
sends:
|
|
80
|
+
- id: FraudReviewCompleted
|
|
81
|
+
version: 0.0.1
|
|
82
|
+
|
|
83
|
+
# Optional data stores this agent reads from
|
|
84
|
+
readsFrom:
|
|
85
|
+
- id: fraud-analytics-db
|
|
86
|
+
version: 0.0.1
|
|
87
|
+
|
|
88
|
+
# Optional badges, rendered to UI by EventCatalog
|
|
89
|
+
badges:
|
|
90
|
+
- content: AI Agent
|
|
91
|
+
backgroundColor: purple
|
|
92
|
+
textColor: purple
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Overview
|
|
96
|
+
|
|
97
|
+
The Fraud Review Agent reviews risky payment attempts before they continue through the payment gateway.
|
|
98
|
+
|
|
99
|
+
<NodeGraph />
|
|
100
|
+
|
|
101
|
+
## Tools
|
|
102
|
+
|
|
103
|
+
<AgentTools />
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Adding content
|
|
107
|
+
|
|
108
|
+
With **agents** you can write any Markdown you want and it will render on your page. Every agent gets its own page.
|
|
109
|
+
|
|
110
|
+
Within your markdown content you can use [components](/docs/development/components/using-components) to add interactive components to your page.
|
|
111
|
+
|
|
112
|
+
## Adding tools to your agent
|
|
113
|
+
|
|
114
|
+
You can document the external tools (MCP servers, APIs, databases) an agent can call.
|
|
115
|
+
|
|
116
|
+
You can read more about adding tools to your agent [here](/docs/development/guides/agents/adding-tools).
|
|
117
|
+
|
|
118
|
+
## Attaching an agent to a domain
|
|
119
|
+
|
|
120
|
+
To associate an agent with a domain, add its `id` to the `agents` array in the domain's frontmatter:
|
|
121
|
+
|
|
122
|
+
```md title="/domains/Payment/index.mdx (example)"
|
|
123
|
+
---
|
|
124
|
+
id: Payment
|
|
125
|
+
name: Payment Domain
|
|
126
|
+
version: 0.0.1
|
|
127
|
+
agents:
|
|
128
|
+
- id: FraudReviewAgent
|
|
129
|
+
version: 0.0.1
|
|
130
|
+
services:
|
|
131
|
+
- id: PaymentService
|
|
132
|
+
version: 0.0.1
|
|
133
|
+
---
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
EventCatalog will show the agent in the domain sidebar and include it in the domain visualiser.
|
|
137
|
+
|
|
138
|
+
## Custom icon
|
|
139
|
+
|
|
140
|
+
Set `styles.icon` in your frontmatter to display a custom icon on the agent. The icon appears in the visualiser node, sidebar navigation, page header, and search results.
|
|
141
|
+
|
|
142
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
143
|
+
---
|
|
144
|
+
id: FraudReviewAgent
|
|
145
|
+
name: Fraud Review Agent
|
|
146
|
+
version: 0.0.1
|
|
147
|
+
styles:
|
|
148
|
+
icon: /icons/agents/fraud-review.svg
|
|
149
|
+
---
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
The value can be a path to a file in your catalog's `public/` folder (e.g. `/icons/logo.svg`) or an absolute URL. [Simple Icons CDN](https://cdn.simpleicons.org) is a useful source for brand logos.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 3
|
|
3
|
+
keywords:
|
|
4
|
+
- EventCatalog agents
|
|
5
|
+
- agent tools
|
|
6
|
+
- MCP
|
|
7
|
+
- AgentTools component
|
|
8
|
+
sidebar_label: Agent tools
|
|
9
|
+
title: Agent tools
|
|
10
|
+
description: Document and display the tools an agent can call.
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
14
|
+
|
|
15
|
+
<AddedIn version="3.41.0" />
|
|
16
|
+
|
|
17
|
+
Agents often call external capabilities to do their work — MCP servers, REST APIs, internal search indexes, or databases. The `tools` array in an agent's frontmatter captures these dependencies so anyone reading the catalog can understand what the agent reaches out to at runtime.
|
|
18
|
+
|
|
19
|
+

|
|
20
|
+
|
|
21
|
+
## Define tools in frontmatter
|
|
22
|
+
|
|
23
|
+
Add a `tools` array to your agent's frontmatter. Each entry describes one tool:
|
|
24
|
+
|
|
25
|
+
```md title="/agents/OrderSupportAgent/index.mdx (example)"
|
|
26
|
+
---
|
|
27
|
+
# id of your agent, used for slugs and references in EventCatalog.
|
|
28
|
+
id: OrderSupportAgent
|
|
29
|
+
|
|
30
|
+
# Display name of the Agent, rendered in EventCatalog
|
|
31
|
+
name: Order Support Agent
|
|
32
|
+
|
|
33
|
+
# Version of the Agent
|
|
34
|
+
version: 0.0.1
|
|
35
|
+
|
|
36
|
+
# Optional external tools the agent can call
|
|
37
|
+
tools:
|
|
38
|
+
# Display name of the tool
|
|
39
|
+
- name: Order lookup
|
|
40
|
+
# Type of tool (e.g. `mcp`, `api`) — free-form string
|
|
41
|
+
type: mcp
|
|
42
|
+
# Optional icon path (from your catalog's `public/` folder) or absolute URL
|
|
43
|
+
icon: /icons/tools/snowflake.svg
|
|
44
|
+
# Optional link to the tool endpoint or documentation
|
|
45
|
+
url: https://mcp.example.com/orders/lookup
|
|
46
|
+
# Optional short description of what the tool does
|
|
47
|
+
description: Retrieves order status, totals, shipment milestones, and recent order events from the operational read model.
|
|
48
|
+
- name: Support case notes
|
|
49
|
+
type: mcp
|
|
50
|
+
icon: /icons/tools/zendesk.svg
|
|
51
|
+
url: https://mcp.example.com/support/case-notes
|
|
52
|
+
description: Appends investigation notes, suggested customer replies, and follow-up actions to the support ticket.
|
|
53
|
+
---
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Tool fields
|
|
57
|
+
|
|
58
|
+
| Field | Required | Description |
|
|
59
|
+
|-------|----------|-------------|
|
|
60
|
+
| `name` | Yes | Display name of the tool |
|
|
61
|
+
| `type` | Yes | Free-form string — use `mcp` for MCP servers, `api` for REST/HTTP endpoints, or any label that fits your stack |
|
|
62
|
+
| `icon` | No | Path in your catalog's `public/` folder or an absolute URL to an icon image |
|
|
63
|
+
| `url` | No | Link to the tool endpoint or documentation |
|
|
64
|
+
| `description` | No | One or two sentences describing what the tool does |
|
|
65
|
+
|
|
66
|
+
The `type` field is a plain string. `mcp` gets special rendering in the catalog (the MCP logo appears next to the badge), but you can use any value that is meaningful to your team.
|
|
67
|
+
|
|
68
|
+
## Render tools on the page
|
|
69
|
+
|
|
70
|
+
Add the [`<AgentTools />`](/docs/development/components/components/agent-tools) component anywhere in your agent's MDX body to render the tools table. The component reads the `tools` array from the current agent's frontmatter — no props needed.
|
|
71
|
+
|
|
72
|
+
```md title="/agents/OrderSupportAgent/index.mdx (example)"
|
|
73
|
+
---
|
|
74
|
+
id: OrderSupportAgent
|
|
75
|
+
# ... rest of frontmatter
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
This agent helps the support team answer order questions.
|
|
79
|
+
|
|
80
|
+
## Tools
|
|
81
|
+
|
|
82
|
+
<AgentTools />
|
|
83
|
+
|
|
84
|
+
## Responsibilities
|
|
85
|
+
|
|
86
|
+
- Summarize the current state of an order for support staff.
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
`<AgentTools />` is only supported inside agent pages. If you add it to a service or message page, the catalog will display a warning and skip the table.
|
|
90
|
+
|
|
91
|
+

|
|
92
|
+
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 4
|
|
3
|
+
keywords:
|
|
4
|
+
- EventCatalog agents
|
|
5
|
+
- LLM model
|
|
6
|
+
- model governance
|
|
7
|
+
- AI governance
|
|
8
|
+
sidebar_label: Model metadata
|
|
9
|
+
title: Model metadata
|
|
10
|
+
description: Capture the LLM provider, model, and version your agent uses.
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
14
|
+
|
|
15
|
+
<AddedIn version="3.41.0" />
|
|
16
|
+
|
|
17
|
+
Every agent can declare the LLM it uses through a `model` block in its frontmatter. This gives your team a single place to see which model powers each agent across your entire catalog.
|
|
18
|
+
|
|
19
|
+

|
|
20
|
+
|
|
21
|
+
## Why track the model?
|
|
22
|
+
|
|
23
|
+
LLM providers release new model versions, retire old snapshots, and change behavior between releases — often without a corresponding code deployment. Capturing `provider`, `name`, and `version` makes it easy to:
|
|
24
|
+
|
|
25
|
+
- Audit which agents are running on deprecated or retired snapshots.
|
|
26
|
+
- Surface model drift when a provider rolls out a new default.
|
|
27
|
+
- Give reviewers the context they need when an agent's output changes unexpectedly.
|
|
28
|
+
|
|
29
|
+
## Add model metadata
|
|
30
|
+
|
|
31
|
+
Add a `model` block to your agent's frontmatter:
|
|
32
|
+
|
|
33
|
+
```md title="/agents/FraudReviewAgent/index.mdx (OpenAI example)"
|
|
34
|
+
---
|
|
35
|
+
id: FraudReviewAgent
|
|
36
|
+
name: Fraud Review Agent
|
|
37
|
+
version: 0.0.1
|
|
38
|
+
|
|
39
|
+
# Optional model metadata describing the LLM this agent runs on
|
|
40
|
+
model:
|
|
41
|
+
# The provider or platform powering the model
|
|
42
|
+
provider: OpenAI
|
|
43
|
+
# The model identifier
|
|
44
|
+
name: gpt-4.1
|
|
45
|
+
# The snapshot or API version of the model
|
|
46
|
+
version: "2025-04-14"
|
|
47
|
+
---
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
```md title="/agents/InventoryRebalancingAgent/index.mdx (Gemini example)"
|
|
51
|
+
---
|
|
52
|
+
id: InventoryRebalancingAgent
|
|
53
|
+
name: Inventory Rebalancing Agent
|
|
54
|
+
version: 0.0.1
|
|
55
|
+
|
|
56
|
+
# Optional model metadata describing the LLM this agent runs on
|
|
57
|
+
model:
|
|
58
|
+
# The provider or platform powering the model
|
|
59
|
+
provider: Gemini
|
|
60
|
+
# The model identifier
|
|
61
|
+
name: gemini-2.5-pro
|
|
62
|
+
# The snapshot or API version of the model
|
|
63
|
+
version: "2025-06-17"
|
|
64
|
+
---
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
```md title="/agents/ProductContentAgent/index.mdx (Anthropic example)"
|
|
68
|
+
---
|
|
69
|
+
id: ProductContentAgent
|
|
70
|
+
name: Product Content Agent
|
|
71
|
+
version: 0.0.1
|
|
72
|
+
|
|
73
|
+
# Optional model metadata describing the LLM this agent runs on
|
|
74
|
+
model:
|
|
75
|
+
# The provider or platform powering the model
|
|
76
|
+
provider: Anthropic
|
|
77
|
+
# The model identifier
|
|
78
|
+
name: claude-sonnet-4-5
|
|
79
|
+
# The snapshot or API version of the model
|
|
80
|
+
version: "20241022"
|
|
81
|
+
---
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Model fields
|
|
85
|
+
|
|
86
|
+
| Field | Required | Description |
|
|
87
|
+
|-------|----------|-------------|
|
|
88
|
+
| `provider` | No | The provider or platform — e.g. `OpenAI`, `Anthropic`, `Gemini`, `Azure OpenAI` |
|
|
89
|
+
| `name` | No | The model identifier — e.g. `gpt-4.1`, `claude-sonnet-4-5`, `gemini-2.5-pro` |
|
|
90
|
+
| `version` | No | The snapshot or API version — e.g. `2025-04-14`, `20241022` |
|
|
91
|
+
|
|
92
|
+
All three fields are optional strings. Use whatever convention your provider uses for model identifiers and snapshot dates.
|
|
93
|
+
|
|
94
|
+
## Model changes and versioning
|
|
95
|
+
|
|
96
|
+
When you upgrade the model an agent uses, consider whether the behavior change is significant enough to warrant a new agent version. Capturing the new `model.version` in a versioned snapshot (see [Versioning](/docs/development/guides/agents/versioning-and-lifecycle/versioning)) gives your team a clear record of when the model changed and who approved it.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"label": "Agents",
|
|
3
|
+
"position": 4,
|
|
4
|
+
"collapsible": true,
|
|
5
|
+
"collapsed": true,
|
|
6
|
+
"link": {
|
|
7
|
+
"type": "generated-index",
|
|
8
|
+
"slug": "/agents",
|
|
9
|
+
"description": "A collection of guides to help you understand agents and how they work with EventCatalog."
|
|
10
|
+
}
|
|
11
|
+
}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
---
|
|
2
|
+
keywords:
|
|
3
|
+
- EventCatalog agents
|
|
4
|
+
- agent messages
|
|
5
|
+
- sends receives
|
|
6
|
+
sidebar_label: Messages
|
|
7
|
+
title: Adding messages to agents
|
|
8
|
+
description: Connecting agents to the messages they produce and consume.
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
12
|
+
|
|
13
|
+
<AddedIn version="3.41.0" />
|
|
14
|
+
|
|
15
|
+
An agent can **receive** messages (events, commands, or queries) that trigger its reasoning, and **send** messages as a result of its actions.
|
|
16
|
+
|
|
17
|
+
Connecting agents to messages keeps the full event topology visible in the visualiser and lets your team trace which agents react to which events.
|
|
18
|
+
|
|
19
|
+

|
|
20
|
+
|
|
21
|
+
## Adding messages to your agent
|
|
22
|
+
|
|
23
|
+
To add messages to an agent you need to define them in either the **sends** or **receives** array within your agent frontmatter API.
|
|
24
|
+
|
|
25
|
+
You need to add the `id` of the message and optionally the `version` of the message.
|
|
26
|
+
|
|
27
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
28
|
+
---
|
|
29
|
+
id: FraudReviewAgent
|
|
30
|
+
... # other agent frontmatter
|
|
31
|
+
receives:
|
|
32
|
+
# id of the message this agent receives
|
|
33
|
+
- id: PaymentInitiated
|
|
34
|
+
# (optional) The version of the message you want to add.
|
|
35
|
+
# If no version is given the latest version of the message will be used.
|
|
36
|
+
version: 0.0.1
|
|
37
|
+
sends:
|
|
38
|
+
# id of the message this agent sends
|
|
39
|
+
- id: FraudCaseCreated
|
|
40
|
+
version: 0.0.1
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
<!-- Markdown contents... -->
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The **receives** and **sends** fields in your agent tell EventCatalog which messages this agent either consumes or publishes.
|
|
48
|
+
|
|
49
|
+
:::info The power of versioning
|
|
50
|
+
When you define your messages for your agent you can define the version of them too. This can be powerful if you have multiple versions of your events, commands or queries. Example could be an event raised by another team — you can pin the exact version your agent reasons over so a future change doesn't silently alter its behaviour.
|
|
51
|
+
:::
|
|
52
|
+
|
|
53
|
+
### Routing messages through channels
|
|
54
|
+
|
|
55
|
+
You can also route your messages through channels. Examples of these could be your brokers, queues, topics, etc.
|
|
56
|
+
|
|
57
|
+
To do this you can use the `to` and `from` fields in your agent frontmatter.
|
|
58
|
+
|
|
59
|
+
This example shows:
|
|
60
|
+
- the `FraudReviewAgent` sending a `FraudCaseCreated` message to the `fraud.events` channel.
|
|
61
|
+
- the `FraudReviewAgent` consuming a `PaymentInitiated` message from the `payments.events` channel.
|
|
62
|
+
|
|
63
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
64
|
+
---
|
|
65
|
+
id: FraudReviewAgent
|
|
66
|
+
... # other agent frontmatter
|
|
67
|
+
|
|
68
|
+
# Agent sends a message called FraudCaseCreated
|
|
69
|
+
# This message is published to the fraud.events channel (e.g broker)
|
|
70
|
+
sends:
|
|
71
|
+
- id: FraudCaseCreated
|
|
72
|
+
to:
|
|
73
|
+
- id: fraud.events
|
|
74
|
+
|
|
75
|
+
# Agent consumes a message called PaymentInitiated
|
|
76
|
+
# This message is consumed from the payments.events channel (e.g queue)
|
|
77
|
+
receives:
|
|
78
|
+
- id: PaymentInitiated
|
|
79
|
+
from:
|
|
80
|
+
- id: payments.events
|
|
81
|
+
---
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
You can read more about routing messages through channels in the [routing messages through channels guide](/docs/development/guides/channels/introduction).
|
|
85
|
+
|
|
86
|
+
### Using semver versioning
|
|
87
|
+
|
|
88
|
+
<AddedIn version="2.4.0" />
|
|
89
|
+
|
|
90
|
+
You can use [semver](https://semver.org/) syntax when referencing your messages in your agents.
|
|
91
|
+
|
|
92
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
93
|
+
---
|
|
94
|
+
id: FraudReviewAgent
|
|
95
|
+
... # other agent frontmatter
|
|
96
|
+
receives:
|
|
97
|
+
# Agent receives a message called RiskScoreCalculated
|
|
98
|
+
# The latest minor/patch version of this event will be used
|
|
99
|
+
- id: RiskScoreCalculated
|
|
100
|
+
version: 1.x.x
|
|
101
|
+
sends:
|
|
102
|
+
# Agent sends a message called FraudCaseCreated
|
|
103
|
+
# This pulls the latest patch version of FraudCaseCreated
|
|
104
|
+
- id: FraudCaseCreated
|
|
105
|
+
version: 2.0.x
|
|
106
|
+
# Agent sends a message called FraudEscalated
|
|
107
|
+
# This pulls the latest minor/patch version of FraudEscalated
|
|
108
|
+
- id: FraudEscalated
|
|
109
|
+
version: >1.0.1
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
<!-- Markdown contents... -->
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Although it's recommended to link to a version of a message it is now optional. If no version is given **latest** is used by default.
|
|
117
|
+
|
|
118
|
+
### Visualizing messages within an agent
|
|
119
|
+
|
|
120
|
+
When messages get added within your agents EventCatalog will visualize this for you either using the `NodeGraph` component or through the visualizer.
|
|
121
|
+
|
|
122
|
+

|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
keywords:
|
|
3
|
+
- EventCatalog agents
|
|
4
|
+
- agent data stores
|
|
5
|
+
- writesTo readsFrom
|
|
6
|
+
sidebar_label: Data stores
|
|
7
|
+
title: Adding data stores to agents
|
|
8
|
+
description: Document the data stores an agent reads from or writes to.
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
12
|
+
|
|
13
|
+
<AddedIn version="3.41.0" />
|
|
14
|
+
|
|
15
|
+
[Data stores](/docs/development/guides/data/introduction) are containers that hold data in your architecture — databases, caches, object stores, search indexes, and so on. Agents can read from and write to these containers, and documenting those relationships keeps the full data-access picture visible in the visualiser.
|
|
16
|
+
|
|
17
|
+
## Specify read/write relationships
|
|
18
|
+
|
|
19
|
+
Add `readsFrom` or `writesTo` arrays to your agent's frontmatter. Provide the `id` of the data store and optionally its `version`.
|
|
20
|
+
|
|
21
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
22
|
+
---
|
|
23
|
+
id: FraudReviewAgent
|
|
24
|
+
version: 0.0.1
|
|
25
|
+
readsFrom:
|
|
26
|
+
- id: fraud-analytics-db
|
|
27
|
+
- id: ml-model-store
|
|
28
|
+
version: 2.0.0
|
|
29
|
+
---
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
```md title="/agents/InventoryRebalancingAgent/index.mdx (example)"
|
|
33
|
+
---
|
|
34
|
+
id: InventoryRebalancingAgent
|
|
35
|
+
version: 0.0.1
|
|
36
|
+
readsFrom:
|
|
37
|
+
- id: inventory-readmodel
|
|
38
|
+
- id: inventory-db
|
|
39
|
+
writesTo:
|
|
40
|
+
- id: rebalancing-audit-log
|
|
41
|
+
---
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
If no version is provided, EventCatalog uses the latest version of the data store.
|
|
45
|
+
|
|
46
|
+
## Visualize data stores
|
|
47
|
+
|
|
48
|
+
When data stores are connected to an agent, EventCatalog visualizes the read/write relationships — either via the `<NodeGraph />` component on the agent page or through the full-screen visualiser.
|
|
49
|
+
|
|
50
|
+

|
|
51
|
+
|
|
52
|
+
You can also control the **Containers** section in the agent's sidebar using `detailsPanel`:
|
|
53
|
+
|
|
54
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
55
|
+
---
|
|
56
|
+
id: FraudReviewAgent
|
|
57
|
+
version: 0.0.1
|
|
58
|
+
detailsPanel:
|
|
59
|
+
containers:
|
|
60
|
+
visible: false
|
|
61
|
+
---
|
|
62
|
+
```
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 1
|
|
3
|
+
keywords:
|
|
4
|
+
- EventCatalog
|
|
5
|
+
- agents
|
|
6
|
+
- owners
|
|
7
|
+
sidebar_label: Owners
|
|
8
|
+
title: Adding agent owners
|
|
9
|
+
description: Adding owners to agents with EventCatalog.
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
13
|
+
|
|
14
|
+
<AddedIn version="3.41.0" />
|
|
15
|
+
|
|
16
|
+
Owners in EventCatalog are either **users** or **teams** and are optional. Assigning owners to an agent makes it clear who is responsible for keeping it up to date, responding to incidents, and approving model upgrades.
|
|
17
|
+
|
|
18
|
+
## Add owners using frontmatter
|
|
19
|
+
|
|
20
|
+
Add the `id` of any user or team to the `owners` array in your agent's frontmatter:
|
|
21
|
+
|
|
22
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
23
|
+
---
|
|
24
|
+
id: FraudReviewAgent
|
|
25
|
+
version: 0.0.1
|
|
26
|
+
owners:
|
|
27
|
+
- dboyne # a user id
|
|
28
|
+
- full-stack # a team id
|
|
29
|
+
---
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
:::tip Creating users and teams
|
|
33
|
+
EventCatalog gives you the ability to create users and teams. You can read the documentation to get started.
|
|
34
|
+
:::
|
|
35
|
+
|
|
36
|
+
## Show owned agents on a team page
|
|
37
|
+
|
|
38
|
+
<AddedIn version="3.41.0" />
|
|
39
|
+
|
|
40
|
+
Teams and users gained an `ownedAgents` array alongside `ownedServices`. Add agent references to a team file to surface owned agents directly on the team's catalog page.
|
|
41
|
+
|
|
42
|
+
```md title="/teams/full-stack.mdx (example)"
|
|
43
|
+
---
|
|
44
|
+
id: full-stack
|
|
45
|
+
name: Full Stack Team
|
|
46
|
+
ownedAgents:
|
|
47
|
+
- id: FraudReviewAgent
|
|
48
|
+
version: 0.0.1
|
|
49
|
+
- id: OrderSupportAgent
|
|
50
|
+
ownedServices:
|
|
51
|
+
- id: PaymentService
|
|
52
|
+
version: 0.0.1
|
|
53
|
+
---
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
The same field is available on user files:
|
|
57
|
+
|
|
58
|
+
```md title="/users/dboyne.mdx (example)"
|
|
59
|
+
---
|
|
60
|
+
id: dboyne
|
|
61
|
+
name: David Boyne
|
|
62
|
+
ownedAgents:
|
|
63
|
+
- id: InventoryRebalancingAgent
|
|
64
|
+
---
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
If no `version` is provided, EventCatalog uses the latest version of the agent.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"label": "Ownership",
|
|
3
|
+
"position": 6,
|
|
4
|
+
"collapsible": true,
|
|
5
|
+
"collapsed": true,
|
|
6
|
+
"link": {
|
|
7
|
+
"type": "generated-index",
|
|
8
|
+
"slug": "/agents-ownership",
|
|
9
|
+
"description": "A collection of guides to help you manage ownership of agents in EventCatalog."
|
|
10
|
+
}
|
|
11
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
keywords:
|
|
3
|
+
- versioning
|
|
4
|
+
- agents
|
|
5
|
+
sidebar_label: Versioning
|
|
6
|
+
title: Versioning
|
|
7
|
+
description: Learn how to version agents in EventCatalog.
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
+
|
|
12
|
+
<AddedIn version="3.41.0" />
|
|
13
|
+
|
|
14
|
+
All content in EventCatalog can be versioned. Versioning an agent lets you keep a historic snapshot whenever the agent's model, tools, or message connections change in a meaningful way.
|
|
15
|
+
|
|
16
|
+
## Version an agent
|
|
17
|
+
|
|
18
|
+
1. Create a `/versioned` directory inside your agent folder if one does not exist yet.
|
|
19
|
+
1. Create a new folder with the version number you are archiving.
|
|
20
|
+
- Example: `/agents/FraudReviewAgent/versioned/0.0.1`
|
|
21
|
+
1. Copy `index.mdx` (and any other files) into that folder.
|
|
22
|
+
- Example: `/agents/FraudReviewAgent/versioned/0.0.1/index.mdx`
|
|
23
|
+
- The `version` inside this file should match `0.0.1`.
|
|
24
|
+
1. Bump the `version` in the root `index.mdx` to the next release.
|
|
25
|
+
- Example: change `version: 0.0.1` to `version: 0.0.2` in `/agents/FraudReviewAgent/index.mdx`.
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
agents/
|
|
29
|
+
FraudReviewAgent/
|
|
30
|
+
index.mdx ← current version (0.0.2)
|
|
31
|
+
versioned/
|
|
32
|
+
0.0.1/
|
|
33
|
+
index.mdx ← archived snapshot
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Navigate versions
|
|
37
|
+
|
|
38
|
+
EventCatalog creates version links automatically on every agent page. Users can also navigate directly by adding the version to the URL (e.g. `/docs/agents/FraudReviewAgent/0.0.1` loads the `0.0.1` snapshot).
|
|
39
|
+
|
|
40
|
+
## When to version
|
|
41
|
+
|
|
42
|
+
Consider creating a new version when you:
|
|
43
|
+
|
|
44
|
+
- Upgrade the underlying LLM to a new model or snapshot.
|
|
45
|
+
- Add or remove a tool that changes what the agent can reach.
|
|
46
|
+
- Change the messages the agent consumes or produces.
|
|
47
|
+
|
|
48
|
+
Smaller documentation edits (fixing typos, improving descriptions) do not need a new version.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
keywords:
|
|
3
|
+
- changelog
|
|
4
|
+
- agents
|
|
5
|
+
sidebar_label: Adding a changelog
|
|
6
|
+
title: Agent changelogs
|
|
7
|
+
description: Adding changelogs to agents in EventCatalog.
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
11
|
+
|
|
12
|
+
<AddedIn version="3.41.0" />
|
|
13
|
+
|
|
14
|
+
EventCatalog supports changelogs for agents. When you version an agent you can attach a `changelog.mdx` to capture what changed and why.
|
|
15
|
+
|
|
16
|
+
## Add a changelog
|
|
17
|
+
|
|
18
|
+
1. Add a `changelog.mdx` to your agent folder (or a versioned snapshot):
|
|
19
|
+
- Current version: `/agents/{Agent}/changelog.mdx`
|
|
20
|
+
- Versioned snapshot: `/agents/{Agent}/versioned/0.0.1/changelog.mdx`
|
|
21
|
+
|
|
22
|
+
```md title="/agents/FraudReviewAgent/changelog.mdx (example)"
|
|
23
|
+
---
|
|
24
|
+
createdAt: 2025-06-01
|
|
25
|
+
badges:
|
|
26
|
+
- content: Model upgrade
|
|
27
|
+
backgroundColor: purple
|
|
28
|
+
textColor: purple
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
### Upgraded to GPT-4.1
|
|
32
|
+
|
|
33
|
+
The agent now runs on `gpt-4.1` (snapshot `2025-04-14`). Response latency for fraud signal explanations dropped by ~30% compared to the previous model. No changes to tools or message connections.
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Navigate to the changelog by clicking the **Changelog** button on the agent page, or visit `/docs/agents/{Agent}/{version}/changelog` directly.
|
|
37
|
+
|
|
38
|
+
## Why add changelogs?
|
|
39
|
+
|
|
40
|
+
Changelogs give your team the context behind model upgrades, tool additions, and prompt changes. They are especially valuable for agents because behavior can shift when the underlying model changes even without a code deployment.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
keywords:
|
|
3
|
+
- EventCatalog
|
|
4
|
+
- agents
|
|
5
|
+
- deprecation
|
|
6
|
+
sidebar_label: Deprecating agents
|
|
7
|
+
title: Deprecating agents
|
|
8
|
+
description: Deprecating agents with EventCatalog.
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
import AddedIn from '@site/src/components/MDX/AddedIn';
|
|
12
|
+
|
|
13
|
+
<AddedIn version="3.41.0" />
|
|
14
|
+
|
|
15
|
+
Any resource in EventCatalog can be deprecated. Deprecating an agent displays a banner on its page so consumers know it is no longer actively maintained.
|
|
16
|
+
|
|
17
|
+
## Deprecate using frontmatter
|
|
18
|
+
|
|
19
|
+
Add the `deprecated` field to your agent's frontmatter:
|
|
20
|
+
|
|
21
|
+
```md title="/agents/FraudReviewAgent/index.mdx (example)"
|
|
22
|
+
---
|
|
23
|
+
id: FraudReviewAgent
|
|
24
|
+
version: 0.0.1
|
|
25
|
+
|
|
26
|
+
# Deprecated as an object (recommended — gives a date and reason)
|
|
27
|
+
deprecated:
|
|
28
|
+
date: 2025-09-01
|
|
29
|
+
message: |
|
|
30
|
+
This agent has been replaced by **FraudReviewAgentV2**, which uses the updated risk scoring pipeline.
|
|
31
|
+
Contact the [Payments team](mailto:payments@example.com) for migration guidance.
|
|
32
|
+
|
|
33
|
+
# Or deprecated as a simple boolean
|
|
34
|
+
deprecated: true
|
|
35
|
+
---
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Using an object is recommended because it gives readers a date and a reason. The `date` can be in the past (already deprecated) or the future (will be deprecated).
|
|
39
|
+
|
|
40
|
+
- `deprecated.date` — Date in `YYYY-MM-DD` format.
|
|
41
|
+
- `deprecated.message` — Markdown string explaining why the agent is deprecated and what to use instead.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"label": "Versioning & lifecycle",
|
|
3
|
+
"position": 5,
|
|
4
|
+
"collapsible": true,
|
|
5
|
+
"collapsed": true,
|
|
6
|
+
"link": {
|
|
7
|
+
"type": "generated-index",
|
|
8
|
+
"slug": "/agents-versioning-and-lifecycle",
|
|
9
|
+
"description": "A collection of guides to help you version and manage the lifecycle of agents in EventCatalog."
|
|
10
|
+
}
|
|
11
|
+
}
|
package/dist/docs/development/guides/domains/02-creating-domains/03-adding-services-to-domains.md
CHANGED
|
@@ -88,3 +88,30 @@ When you view your domain in EventCatalog, the services will be visualized for y
|
|
|
88
88
|
|
|
89
89
|
You can make as many changes as you want, but if you are adding/removing services you may want to consider versioning your domain. This allows you to keep historic changes, and let others understand why services are coming in/out of a particular domain.
|
|
90
90
|
|
|
91
|
+
## Add agents to a domain
|
|
92
|
+
|
|
93
|
+
<AddedIn version="3.41.0" />
|
|
94
|
+
|
|
95
|
+
[Agents](/docs/development/guides/agents/introduction) can be attached to a domain the same way services can. Add an `agents` array to your domain's frontmatter:
|
|
96
|
+
|
|
97
|
+
```md title="/domains/Payment/index.mdx (example)"
|
|
98
|
+
---
|
|
99
|
+
id: Payment
|
|
100
|
+
name: Payment Domain
|
|
101
|
+
version: 0.0.1
|
|
102
|
+
services:
|
|
103
|
+
- id: PaymentService
|
|
104
|
+
version: 0.0.1
|
|
105
|
+
agents:
|
|
106
|
+
- id: FraudReviewAgent
|
|
107
|
+
version: 0.0.1
|
|
108
|
+
# version is optional — latest is used if omitted
|
|
109
|
+
- id: AnotherAgent
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
<!-- Markdown content... -->
|
|
113
|
+
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
EventCatalog will show the agents in the domain sidebar and include them in the domain visualiser alongside services.
|
|
117
|
+
|
|
@@ -64,6 +64,7 @@ next_steps:
|
|
|
64
64
|
- [externalSystem](#externalsystem) — Represents an external system in your flow diagram
|
|
65
65
|
- [message](#message) — Represents an event, command or query resource in EventCatalog
|
|
66
66
|
- [service](#service) — Represents a service resource in EventCatalog
|
|
67
|
+
- [agent](#agent) — Represents an agent resource in EventCatalog (added in EventCatalog 3.41.0)
|
|
67
68
|
- [flow](#flow) — Represents a flow in EventCatalog (added in EventCatalog 2.34.2)
|
|
68
69
|
- [container](#container) — Represents a data store (container) resource in EventCatalog
|
|
69
70
|
- [dataProduct](#dataproduct) — Represents a data product resource in EventCatalog
|
|
@@ -172,6 +173,35 @@ steps:
|
|
|
172
173
|
|
|
173
174
|
---
|
|
174
175
|
|
|
176
|
+
### agent {#agent}
|
|
177
|
+
|
|
178
|
+
<AddedIn version="3.41.0" />
|
|
179
|
+
|
|
180
|
+
Represents and refers to an [agent](/docs/development/guides/agents/introduction) resource in EventCatalog. Agents render as purple/violet nodes in the visualiser so they are easy to distinguish from services. When a flow references an agent, the agent's page shows a back-link to the flow.
|
|
181
|
+
|
|
182
|
+
#### Agent properties
|
|
183
|
+
|
|
184
|
+
| Property | Type | Required | Description |
|
|
185
|
+
|----------|------|----------|-------------|
|
|
186
|
+
| `id` | `string` | **Yes** | The id of the agent in your catalog |
|
|
187
|
+
| `version` | `string` | No | The version to reference (defaults to `latest`) |
|
|
188
|
+
|
|
189
|
+
```yml
|
|
190
|
+
steps:
|
|
191
|
+
- id: "fraud_review"
|
|
192
|
+
title: "Fraud Review Agent"
|
|
193
|
+
agent:
|
|
194
|
+
id: "FraudReviewAgent"
|
|
195
|
+
version: "0.0.1"
|
|
196
|
+
next_steps:
|
|
197
|
+
- id: "payment_approved"
|
|
198
|
+
label: "Approved"
|
|
199
|
+
- id: "payment_declined"
|
|
200
|
+
label: "Declined"
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
175
205
|
### flow
|
|
176
206
|
|
|
177
207
|
<AddedIn version="2.34.2" />
|
package/dist/eventcatalog.cjs
CHANGED
|
@@ -114,7 +114,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
|
|
|
114
114
|
var import_picocolors = __toESM(require("picocolors"), 1);
|
|
115
115
|
|
|
116
116
|
// package.json
|
|
117
|
-
var version = "3.41.
|
|
117
|
+
var version = "3.41.1";
|
|
118
118
|
|
|
119
119
|
// src/constants.ts
|
|
120
120
|
var VERSION = version;
|
package/dist/eventcatalog.js
CHANGED
|
@@ -13,8 +13,8 @@ import {
|
|
|
13
13
|
} from "./chunk-3H2RT3CM.js";
|
|
14
14
|
import {
|
|
15
15
|
log_build_default
|
|
16
|
-
} from "./chunk-
|
|
17
|
-
import "./chunk-
|
|
16
|
+
} from "./chunk-UGNBEYJJ.js";
|
|
17
|
+
import "./chunk-6C2H2YLW.js";
|
|
18
18
|
import "./chunk-3DVHEVHQ.js";
|
|
19
19
|
import {
|
|
20
20
|
catalogToAstro
|
|
@@ -28,13 +28,13 @@ import {
|
|
|
28
28
|
} from "./chunk-ULZYHF3V.js";
|
|
29
29
|
import {
|
|
30
30
|
generate
|
|
31
|
-
} from "./chunk-
|
|
31
|
+
} from "./chunk-Z5A2F2DN.js";
|
|
32
32
|
import {
|
|
33
33
|
logger
|
|
34
|
-
} from "./chunk-
|
|
34
|
+
} from "./chunk-GNLFCESR.js";
|
|
35
35
|
import {
|
|
36
36
|
VERSION
|
|
37
|
-
} from "./chunk-
|
|
37
|
+
} from "./chunk-X5JM6SAH.js";
|
|
38
38
|
import {
|
|
39
39
|
getEventCatalogConfigFile,
|
|
40
40
|
verifyRequiredFieldsAreInCatalogConfigFile
|
package/dist/generate.cjs
CHANGED
package/dist/generate.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
2
|
generate
|
|
3
|
-
} from "./chunk-
|
|
4
|
-
import "./chunk-
|
|
5
|
-
import "./chunk-
|
|
3
|
+
} from "./chunk-Z5A2F2DN.js";
|
|
4
|
+
import "./chunk-GNLFCESR.js";
|
|
5
|
+
import "./chunk-X5JM6SAH.js";
|
|
6
6
|
import "./chunk-5T63CXKU.js";
|
|
7
7
|
export {
|
|
8
8
|
generate
|
package/dist/utils/cli-logger.js
CHANGED
package/package.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
},
|
|
8
8
|
"license": "SEE LICENSE IN LICENSE",
|
|
9
9
|
"type": "module",
|
|
10
|
-
"version": "3.41.
|
|
10
|
+
"version": "3.41.1",
|
|
11
11
|
"publishConfig": {
|
|
12
12
|
"access": "public"
|
|
13
13
|
},
|
|
@@ -113,9 +113,9 @@
|
|
|
113
113
|
"update-notifier": "^7.3.1",
|
|
114
114
|
"uuid": "^10.0.0",
|
|
115
115
|
"zod": "^4.3.6",
|
|
116
|
-
"@eventcatalog/
|
|
117
|
-
"@eventcatalog/
|
|
118
|
-
"@eventcatalog/
|
|
116
|
+
"@eventcatalog/linter": "1.0.26",
|
|
117
|
+
"@eventcatalog/sdk": "2.23.0",
|
|
118
|
+
"@eventcatalog/visualiser": "^3.22.0"
|
|
119
119
|
},
|
|
120
120
|
"devDependencies": {
|
|
121
121
|
"@astrojs/check": "^0.9.9",
|
/package/dist/docs/development/components/components/{04-attachments.md → 05-attachments.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/dist/docs/development/components/components/{11-message-table.md → 12-message-table.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/dist/docs/development/components/components/{15-remote-schema.md → 16-remote-schema.md}
RENAMED
|
File without changes
|
|
File without changes
|
/package/dist/docs/development/components/components/{17-resource-link.md → 18-resource-link.md}
RENAMED
|
File without changes
|
|
File without changes
|
/package/dist/docs/development/components/components/{19-schema-viewer.md → 20-schema-viewer.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|