Workstate Docs

Limits & defaults ​

This page lists Workstate's limits and defaults in one place. Sizes follow the console: 1 MB is 1,048,576 bytes, except where a byte count is given.

Accounts and sign-in ​

WhatLimit or default
Signing inWith GitHub only
Sign-upBy invitation
Console session7 days

Namespaces ​

WhatLimit or default
Namespace name1 to 80 characters
Namespace idws- followed by 32 hexadecimal characters. Some older namespaces have other ids, such as default.
Namespace used when a request names noneYour oldest namespace

API keys ​

WhatLimit or default
Live keys per person25
Key labelRequired, 1 to 64 printable characters
Key expiryNone. A key works until it is revoked.
What a key reachesEvery namespace its owner has access to
When you see the keyOnce, when you create it
Where keys are createdOnly in the console, while signed in

Sources ​

WhatLimit or default
Source name1 to 64 characters: letters, digits, spaces, -, _ and .
Schedule for a new GitHub, Confluence or Jira sourceEvery day, after a first sync that starts at once
Schedules to choose fromEvery 5 minutes, 15 minutes, hour, 6 hours, day or week
Shortest schedule5 minutes
Syncs running at once, per account2 by default. Others wait their turn.
Retries of a failed syncUp to 5 attempts in all. The pause before the first retry is about 30 seconds, and it doubles each time.
Syncs shown in Sync historyThe last 20

GitHub ​

WhatLimit or default
What is readThe latest commit on each repository's default branch
Where fromgithub.com. GitHub Enterprise Server is not supported yet.
Largest file indexed1,000,000 bytes
Longest line50,000 bytes. A file with a longer line is skipped as generated.
Time to finish installing the App on GitHub30 minutes

Confluence and Jira ​

WhatLimit or default
SitesAtlassian Cloud only, at *.atlassian.net
Spaces or projects per source50
Pages or issues per source20,000
Comments per Jira issue500, oldest first
Text indexed per page or issue8 MB. Longer text is cut, with a note at the cut.
Time to check a token when you save it25 seconds

Upload files ​

WhatLimit or default
Text, Markdown or code file1,000,000 bytes (the console shows 977 KB)
PDF, Word, Excel or PowerPoint file50 MB
One upload source2 GB and 20,000 files
Text indexed per document8 MB. Longer text is cut, with a note at the cut.
Path of a file512 bytes at most, with each file or folder name at most 255 bytes, and at most 16 levels deep, counting the file
One upload request256 MB. The console sends batches of up to 32 MB or 100 files.
Each top-level folder is a repositoryChosen when you create the source. It cannot be changed later.
WhatLimit or default
Results returned by default8
Candidates ranked per search50. A search returns at most 50 results.
top_k in the REST API1 to 100
RerankingOn by default
Passage sizeUp to 512 tokens, overlapping the next passage by 64 tokens
Code split by syntaxRust, Python, TypeScript, JavaScript, C, C++, Bash and Ruby. Markdown is split by its structure. Other files are split as plain text.
Time a REST search can take60 seconds

Ledger ​

WhatLimit or default
Topic typesdecision, incident, defect, investigation
Statusesopen, proposed, accepted, resolved, superseded, reverted, wontfix
Starting statusproposed for a decision, open for the other types
Project name for a topicLetters, digits, ., - and _
Topic idThe project name, a hyphen, and a number of at least four digits, such as payments-0012
Results from ledger_search by default8. For archived topics, 50.
Page of POST /v1/ledger/list50 topics by default, 200 at most
Editing historyNot possible. History is append-only.

MCP servers ​

WhatLimit or default
Serversrag-corpus at https://mcp-uat.workstate.io/corpus and rag-ledger at https://mcp-uat.workstate.io/ledger
TransportStreamable HTTP. The servers are stateless, so there are no sessions to expire.
AuthenticationAn API key in the Authorization: Bearer header. MCP OAuth is not supported yet.

Workstate is built by Nerdstorm Pty Ltd, Sydney.