docs(store): add AI documentation - AGENTS.md and ARCHITECTURE.md #592

Shreyas281299 · 2026-01-14T07:53:01Z

COMPLETES N/A - Documentation Enhancement

This pull request addresses

Adding AI-optimized documentation for the MobX store package to help AI assistants understand the centralized state management patterns.

by making the following changes

Added packages/contact-center/store/ai-docs/AGENTS.md - Usage documentation and API reference
Added packages/contact-center/store/ai-docs/ARCHITECTURE.md - Technical implementation details and data flows

Change Type

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Tooling change
Internal code refactor

The following scenarios were tested

The testing is done with the amplify link

The GAI Coding Policy And Copyright Annotation Best Practices

Checklist before merging

I have not skipped any automated checks
All existing and new tests passed
I have updated the testing document
I have tested the functionality with amplify link

Make sure to have followed the contributing guidelines before submitting.

aws-amplify-us-east-2 · 2026-01-14T07:58:18Z

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-592.d1b38q61t1z947.amplifyapp.com

Kesari3008 · 2026-01-18T11:40:37Z

packages/contact-center/store/ai-docs/AGENTS.md

+
+## Overview
+
+`@webex/cc-store` is the shared, singleton MobX store for all Contact Center widgets. It holds global agent,session and task state, proxies SDK events, and exposes convenience APIs for fetching lists (queues, entry points, address book), task lifecycle handling, and common mutations.


How does it understand what SDK here is and how SDK is consumed in the Contact Center widgets ? We should add that as well before directly mentioning that it proxies SDK events.

With this text: exposes convenience APIs for fetching lists (queues, entry points, address book), are we talking about what APIs we expose from widgtes or the APIs we are using from SDK ?

Discussed with Priya, we will be creating a knowledgbase that will provide all this information to the agent.

Kesari3008 · 2026-01-18T12:06:13Z

packages/contact-center/store/ai-docs/AGENTS.md

+
+// Option B: Let the store initialize Webex for you, best for new apps
+await store.init({
+  webexConfig: {/* sdk config */},


Instead of saying sdk config here in bracket, can we not provide reference to dev portal documentation where it talks about what webex config looks like ? Can it read from the links attached ? And if not that then maybe we should add that information locally either here or in separate .md file

This config would be provided in the knowledge base so Im not changing anything here. If we find that agent is unable to use this then we will re-visit this and make changes

Kesari3008 · 2026-01-18T12:07:09Z

packages/contact-center/store/ai-docs/AGENTS.md

+
+// Option A: If you already have a Webex instance, best for existing webex enabled apps
+await store.init({
+  webex: someWebexInstance, // must include cc


Same comment here, how will it understand what 'must include cc' means ? There should be a reference for what webex instance looks like

Kesari3008 · 2026-01-18T12:17:39Z

packages/contact-center/store/ai-docs/AGENTS.md

+
+## Overview
+
+`@webex/cc-store` is the shared, singleton MobX store for all Contact Center widgets. It holds global agent,session and task state, proxies SDK events, and exposes convenience APIs for fetching lists (queues, entry points, address book), task lifecycle handling, and common mutations.


Suggested change

`@webex/cc-store` is the shared, singleton MobX store for all Contact Center widgets. It holds global agent,session and task state, proxies SDK events, and exposes convenience APIs for fetching lists (queues, entry points, address book), task lifecycle handling, and common mutations.

`agent, session

Kesari3008 · 2026-01-18T12:51:54Z

packages/contact-center/store/ai-docs/AGENTS.md

+- **Singleton** state via MobX observables
+- **Event wiring** to SDK (TASK_EVENTS and CC_EVENTS)
+- **Task list management** and current task tracking
+- **Helpers** for buddy agents, queues, entry points, address book


Do we have helper functions only for these 4: buddy agents, queues, entry points, address book ? What is different between these helper functions and other functions in storeEventsWrapper file. We should add more clear description to say what these helper functions are for and in e.g we can talk about like buddy agents, queues etc

Updated the text, we have helper for more actions but Ive updated the text to be a little broader and not to specific

Kesari3008 · 2026-01-19T07:05:52Z

packages/contact-center/store/ai-docs/AGENTS.md

+### Fetching Lists
+
+```typescript
+// Buddy agents for current task media type


Adding a statement to help it link and understand where these helper methods are required would be clearer. With this, I don't get the answer of why these helper methods are needed in store file

Kesari3008 · 2026-01-19T07:06:20Z

packages/contact-center/store/ai-docs/AGENTS.md

+
+---
+
+## Key API (Selected)


This heading is not very accurate as properties are not APIs and wht do we have Selected in bracket

Kesari3008 · 2026-01-19T07:14:31Z

packages/contact-center/store/ai-docs/ARCHITECTURE.md

+  end
+  Store->>SDK: register()
+  SDK-->>Store: Profile
+  Store->>Store: populate observables, feature flags


What do we mean by populate observable here ? I have seen the same text even in above tables. What observables are these from SDK ?

The observable are from the mobx store which are proxied in storeEventsWrapper

Kesari3008 · 2026-01-19T07:22:44Z

packages/contact-center/store/ai-docs/ARCHITECTURE.md

+    Store->>SDK: Webex.init()
+    SDK-->>Store: ready
+    Store->>Store: setupEventListeners(webex.cc)
+    Store->>Store: registerCC(webex)


Why are there multiple invocations of registerCC and register in initialization flow ?

So we have talked about two cases here

App pass webexInstance, here we just setup eventListeners and call registerCC

App passes access_token, here we do webex.init, wait for ready then setup eventListeners and call registerCC.

After calling register CC, we get the agentProfile and we resolve

There was 1 extra 'register' that ive removed

Kesari3008 · 2026-01-19T07:23:55Z

packages/contact-center/store/ai-docs/ARCHITECTURE.md

+store.refreshTaskList();
+```
+
+### Address Book Empty


Is this put as an example for one of the errors or if we are putting specific errors then complete list should be given else general guidelines for troubleshooting would be better

Its just an example, the whole list is supposed to be provided by the SDK so it will live in the knowledge base

docs(store): add AI documentation - AGENTS.md and ARCHITECTURE.md

9b76462

Shreyas281299 mentioned this pull request Jan 14, 2026

docs(store): add AI documentation - AGENTS.md and ARCHITECTURE.md #574

Closed

Kesari3008 requested changes Jan 19, 2026

View reviewed changes

Shreyas281299 requested a review from Kesari3008 February 4, 2026 06:31

Shreyas281299 added 3 commits February 4, 2026 12:13

Merge branch 'next' into ai-docs-store

49f41ab

docs(store): review

cdb9a23

Merge remote-tracking branch 'upstream/next' into ai-docs-store

4ce6a91

Shreyas281299 added the validated Indicates that the PR is ready for actions label Feb 4, 2026


		## Overview

		`@webex/cc-store` is the shared, singleton MobX store for all Contact Center widgets. It holds global agent,session and task state, proxies SDK events, and exposes convenience APIs for fetching lists (queues, entry points, address book), task lifecycle handling, and common mutations.

	`@webex/cc-store` is the shared, singleton MobX store for all Contact Center widgets. It holds global agent,session and task state, proxies SDK events, and exposes convenience APIs for fetching lists (queues, entry points, address book), task lifecycle handling, and common mutations.
	`agent, session

docs(store): add AI documentation - AGENTS.md and ARCHITECTURE.md #592

Are you sure you want to change the base?

docs(store): add AI documentation - AGENTS.md and ARCHITECTURE.md #592

Conversation

Shreyas281299 commented Jan 14, 2026

COMPLETES N/A - Documentation Enhancement

This pull request addresses

by making the following changes

Change Type

The following scenarios were tested

The GAI Coding Policy And Copyright Annotation Best Practices

Checklist before merging

Uh oh!

aws-amplify-us-east-2 bot commented Jan 14, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants