@dialpad/dialtone-mcp-server 1.8.0 → 1.9.0
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 +5 -0
- package/RETRIEVAL.md +17 -3
- package/build/index.js +5911 -2461
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,6 +6,8 @@ Filters deprecated items from general discovery, retains exact legacy-name match
|
|
|
6
6
|
|
|
7
7
|
See [the retrieval contract](./RETRIEVAL.md) for readable searches, structured component/API and prose detail, compatible search inputs, provenance and continuation. Searches return Markdown text; only the two selected detail tools advertise structured output.
|
|
8
8
|
|
|
9
|
+
Set `DIALTONE_PROJECT_ROOT` to an absolute application dependency directory to select installed lookup data. Without configuration, lookups stay bundled. See [installed project selection](./RETRIEVAL.md#installed-project-selection) for lookup boundaries, hoisting and restart behavior.
|
|
10
|
+
|
|
9
11
|
## Installation
|
|
10
12
|
|
|
11
13
|
There are three ways to install the Dialtone MCP Server. **Project-scoped installation takes priority** over user-scoped when both exist.
|
|
@@ -204,6 +206,9 @@ pnpm nx run dialtone-mcp-server:test-startup
|
|
|
204
206
|
|
|
205
207
|
From the package directory, `pnpm run test:startup` invokes `node --test` directly
|
|
206
208
|
and requires an existing server build. Use the Nx target above to build first.
|
|
209
|
+
Protocol checks likewise build first with `pnpm nx run dialtone-mcp-server:test-protocol`.
|
|
210
|
+
The package-level `pnpm run test:protocol` is a direct Node/tsx runner and requires
|
|
211
|
+
a current build; CI builds both adapters before invoking it.
|
|
207
212
|
Release-path regressions run with `pnpm run test:release-paths`.
|
|
208
213
|
Both regression suites run in the path-filtered Unit Tests workflow.
|
|
209
214
|
|
package/RETRIEVAL.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# MCP retrieval contract
|
|
2
2
|
|
|
3
|
-
The five `search_*` tools return readable Markdown text only. They do not advertise `outputSchema` or return `structuredContent`. Search results retain the shared domain formatters' facts and search notes: every utility property and usage, three token theme samples and usage, component descriptions and sampled API/import hints, icon categories/keywords/component imports, and documentation excerpts/links. Each page appends its matched/returned counts,
|
|
3
|
+
The five `search_*` tools return readable Markdown text only. They do not advertise `outputSchema` or return `structuredContent`. Search results retain the shared domain formatters' facts and search notes: every utility property and usage, three token theme samples and usage, component descriptions and sampled API/import hints, icon categories/keywords/component imports, and documentation excerpts/links. Each page appends its matched/returned counts, selected source package/version/exact artifact SHA256, and an explicit statement that installed compatibility is not checked.
|
|
4
4
|
|
|
5
5
|
All searches advertise and execute a default `limit` of 15. Queries are plain strings; additional arguments are accepted. Fractional numeric limits and harmless numeric strings retain the existing array-slice behavior, and zero retains the default of 15. Search limits are not reduced by a token budget. Whitespace-only queries return an explicit no-match message without an error. Long queries reach the existing domain search; documentation search retains its own truncation and notes. There is no new global query-length or matching rule.
|
|
6
6
|
|
|
@@ -10,14 +10,28 @@ Token summaries preserve three named theme samples, explicitly label them as inc
|
|
|
10
10
|
|
|
11
11
|
Component searches preserve the existing first-five-prop sample, sampled event/slot names, available value samples, descriptions and import hints. The adapter labels this API as incomplete and supplies `get_component` calls. Use a canonical name or unique alias to select one component: `{ "component": "DtButton", "projection": "props", "field": "kind" }` returns the complete available property record, including values, defaults and deprecation tags. Projections are `all` (default), `props`, `events`, `slots`, `methods` and `expose`. Missing metadata remains unknown; selection never substitutes a feature-search candidate.
|
|
12
12
|
|
|
13
|
-
Documentation search retains its readable excerpts and links, then supplies exact section IDs and `get_documentation` calls. For example, `{ "id": "components/checkbox#accessibility" }` retrieves available accessibility prose beyond the search excerpt. Follow the returned `textOffset` continuation for remaining content. Text offsets count Unicode code points.
|
|
13
|
+
Documentation search retains its readable excerpts and links, then supplies exact section IDs and `get_documentation` calls. For example, `{ "id": "components/checkbox#accessibility" }` retrieves available accessibility prose beyond the search excerpt. Follow the returned `textOffset` continuation for remaining content. Text offsets count Unicode code points. Reference excerpts may contain code fragments; these do not establish complete runnable examples.
|
|
14
|
+
|
|
15
|
+
The selected `examples/button-default` and `examples/button-disabled-tooltip` records contain five complete application files, source qualification and validation metadata. Subject-based component search and documentation source sections supply bounded IDs and `get_documentation` calls; exact source/component detail exposes the full exampleIds list. Unknown example IDs list available IDs and provide search recovery; ordinary documentation search excludes complete example records. Follow every returned text continuation before assembling files. Their `dt10-pinned` profile is umbrella 10.5.1, icons 5.2.0 and Vue 3.5.18, separately qualified from the documentation source version and installed data. Recorded build/API checks apply only to the identified payload hash; source or file changes invalidate them. Manual spot checks record the reviewer and browser/AT versions separately and apply only to the matching payload hash. Neither a build nor retrieval proves accessibility or installed-project compatibility.
|
|
14
16
|
|
|
15
17
|
Only `get_component` and `get_documentation` advertise structured output. Their C2 schema version 1 envelopes appear in `structuredContent` and in a text fallback containing the same JSON facts: match state, selected identity, source, counts, omissions and continuation. Their selectors remain trimmed nonempty strings of at most 256 characters, and their schemas reject unknown fields. Component detail accepts integer limits 1–50 (default 20) and record offsets 0–100000. Documentation detail accepts text limits 1–10000 (default 6000) and text offsets 0–1000000. Invalid detail arguments return an error envelope. `truncation.truncated` reports remaining records, remaining prose or other recorded omissions; reaching the final page alone does not mark a reply truncated.
|
|
16
18
|
|
|
17
19
|
These two selected detail tools retain a budget of 12000 estimated tokens, using `ceil(UTF-8 bytes of compact envelope JSON / 4)`. This is a rough estimate, not a model tokenizer or measured saving. Component records stay intact; allowed values, payloads and scoped bindings are never silently sliced. An oversized atomic contract reports `unavailable` and `atomic_contract_exceeds_budget`; request a narrower projection or named field. No continuation is emitted if it cannot make progress. This budget does not constrain readable searches or token-theme text pages.
|
|
18
20
|
|
|
19
|
-
Structured detail sources report bundled selection and `installedCompatibility: not_checked`. Each domain includes package/version/schema
|
|
21
|
+
Structured detail sources report `bundled`, `installed` or `mixed` selection and `installedCompatibility: not_checked`. Each domain includes package/version/schema and `hash` (SHA256 of exact artifact bytes). Bundled domains also include `contentHash` (SHA256 of canonically ordered JSON with only the declared repository prefix removed from `sourceFiles`, retaining semantic directories). Installed domains omit this optional normalized hash because their repository prefix is unknown. Unversioned legacy formats report schema version 1; unsupported formats fall back explicitly. `buildHash` combines domain content identities and package/schema versions. Raw hashes can differ across checkout paths; normalized identity remains stable when declared repository prefixes alone differ. Stamps contain no timestamp or absolute build path. Hash equality identifies data; it does not prove correctness or consumer availability.
|
|
20
22
|
|
|
21
23
|
Import hints verify stated exports only; they do not establish installed runtime imports, peers or compatibility. Documentation links come from authored API references and literal companions joined through public component identities and VuePress routes. They identify latest production references with readiness and API-content verification stated separately. Missing associations have no invented URL; conflicting associations have no asserted primary URL. Migration advice stays separate from a component's documentation page. Deployed availability and API completeness require separate verification.
|
|
22
24
|
|
|
23
25
|
Initialization instructions describe readable summaries, selected detail, continuation and source qualification within 100 words, with essential routing in the first 512 characters. The existing `dialtone://client-rules` resource remains available. SDK protocol checks do not establish automatic consumption by a named assistant client.
|
|
26
|
+
|
|
27
|
+
## Installed project selection
|
|
28
|
+
|
|
29
|
+
`DIALTONE_PROJECT_ROOT` explicitly names the absolute application dependency root. Optional `DIALTONE_LOOKUP_ROOT` permits ancestor hoisting inside a bounded workspace. No client Roots request, implicit cwd selection, downward discovery, per-call path, watcher or protocol upgrade is involved. Separate applications use separate server instances. Configuration and dependencies are captured at startup; restart after changes.
|
|
30
|
+
|
|
31
|
+
In pnpm workspaces, and other layouts where package symlinks resolve outside the application folder, also set `DIALTONE_LOOKUP_ROOT` to the workspace root.
|
|
32
|
+
|
|
33
|
+
The Node-only query-core entry `@dialpad/dialtone-query-core/node` is shared with the CLI through compatibility re-exports. The default entry stays free of runtime filesystem imports; existing deep import paths remain available. CLI resolution remains unchanged. The MCP policy accepts declared packages only, gives the umbrella precedence, and confines package/data/entry realpaths to its authorized boundary and repository. It preserves unknown legacy fields, rejects malformed or unsupported datasets and falls back per domain. Bundled fallback retains source-verified metadata/imports without claiming installed verification. Missing export evidence is unverified; only a complete parsed installed entry can establish an unavailable export. An exported name with no metadata does not receive a fabricated API.
|
|
34
|
+
|
|
35
|
+
Each selected domain records its actual data SHA256, package version, installed/bundled selection and fallback reason. Documentation and its component-link catalog stay bundled/latest-qualified, with no fallback reason for these expected reference sources. Startup stderr and search/detail replies report installed-data failures and version-mismatch warnings. `buildHash` continues to identify the adapter's bundled build; per-domain hashes identify selected installed data. Resource payloads retain their JSON shape and use the same captured data as tools; `_meta.dialtone` records resource source and the unverified runtime-compatibility boundary. Client rules remain bundled policy, not a version-compatibility guarantee.
|
|
36
|
+
|
|
37
|
+
Workspace declarations are resolved from the application toward the explicit lookup root, stopping at Git boundaries. The closest manifest declaring Dialtone packages owns selection; declarations from separate applications are never combined.
|