Onboarding kit
A welcome message, a team page and agent instructions your team can copy.
What's in the kit
- A welcome message to send each person when you invite them.
- A team page to publish wherever your team keeps its docs.
- Agent instructions: the shared rules on Agent instructions, plus your team's own additions.
Fill in the parts in square brackets. Send the message only once the person's invitation exists, with the namespaces they need.
Welcome message
Workstate doesn't send invitation emails, so this message is the invitation.
text
Subject: You're invited to Workstate
Hi [name],
[Team] is piloting Workstate for the next [number] weeks. It gives your AI agent our shared memory, [our sources, for example "our GitHub repositories and the Support Jira project"], plus a ledger of what we decided and why. Your agent searches it before acting, cites what it finds, and records what we decide.
Setup takes about 15 minutes:
1. Go to https://console-uat.workstate.io and select "Continue with GitHub". Use a GitHub account that has [invited email address] as a verified email. There's no separate invitation email; this message is it. You'll reach [namespace names] as soon as you're signed in.
2. Open "API keys". In "Create a key", enter a label such as "claude-code on my laptop", then select "Create key". Copy the key now: it's shown only once.
3. Store the key as RAG_API_KEY in the environment where your agent runs. Never put it in a file you commit. Setup guide for your agent: [link to your client's guide]
4. Pick [namespace name] in the namespace switcher at the top of the sidebar. Then, under "Connect your agent", select "Copy" and paste the config into .mcp.json in your project. If the two server names end in a long id (rag-corpus-ws-…), rename them to rag-corpus and rag-ledger, the names our agent instructions use.
5. Add our agent instructions from our team page: [link to your team page]
6. Try it. Ask your agent: "[the prompt from your first use case]"
Questions? [Champion's name] runs office hours on [day and time] in [place].
[Your name]Team page
Publish this where your team keeps its docs. If that's a Confluence space that Workstate indexes, agents can find your team's conventions too.
text
# Workstate for [team]
## What it's for
[One or two sentences: the problems from the launch plan.]
## Where things are
| Namespace | Id | What's in it |
| --- | --- | --- |
| [name] | ws-[id] | [sources] |
Sources sync [how often]. Anyone can select "Sync now" on the Sources page.
## Connect your agent
- Claude Code: https://docs.workstate.io/agents/claude-code
- Claude desktop: https://docs.workstate.io/agents/claude-desktop
- Cursor: https://docs.workstate.io/agents/cursor
- Codex: https://docs.workstate.io/agents/codex
If every call fails with 401, your agent isn't receiving RAG_API_KEY. On macOS, apps started from the Dock don't read your shell profile. Your client's guide shows how to pass the key.
## Our agent instructions
Start from https://docs.workstate.io/agents/instructions, then add:
- Record ledger topics in project [project name], or under the repository's name for code.
- [Team rules from your use-case cards]
## Our use cases
[Three to five cards from the use-case workshop]
## Ledger conventions
- One topic per decision or finding. Types: decision, incident, defect, investigation.
- Search before you record, so you don't duplicate a topic.
- When a decision changes, record a new one and supersede the old one.
- Never put secrets or personal data in a topic. The history is append-only.
## Limits
- Everyone with access to a namespace sees everything in it.
- [Anything your team must keep out of Workstate]
## Help
Champions: [names]. Office hours: [day, time, place].Agent instructions
The shared rules on Agent instructions teach an agent to search first, cite what it uses and record what it decides. Add your team's rules after them, such as your project names and the prompts from your use cases. Each page under Use cases has a block of team rules to start from.
Before you send
- The person's invitation is on the Team page, for an email address their GitHub account has verified.
- Their row in the Namespaces column on Team shows the namespaces they need.
- Each source has synced at least once, so their first search returns something.
- A champion is ready to help in the first week.