Skip to content

feat: extract component docs for tool description#356

Merged
Mossaka merged 8 commits into
microsoft:mainfrom
Mossaka:mossaka/component-docs-take-2
Oct 9, 2025
Merged

feat: extract component docs for tool description#356
Mossaka merged 8 commits into
microsoft:mainfrom
Mossaka:mossaka/component-docs-take-2

Conversation

@Mossaka

@Mossaka Mossaka commented Oct 9, 2025

Copy link
Copy Markdown
Contributor

Closese #22

…generation

Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>
…essing step

Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>
Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>
@Mossaka Mossaka changed the title feat: extract component docs for tool description" feat: extract component docs for tool description Oct 9, 2025
@Mossaka Mossaka requested review from Copilot and thomastaylor312 and removed request for thomastaylor312 October 9, 2025 00:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for extracting and utilizing embedded documentation from WebAssembly components, improving tool descriptions with documentation from WIT source files instead of auto-generated placeholders.

  • Extracts package documentation from the 'package-docs' custom section in WASM components
  • Adds new API functions to generate schemas and tools using extracted documentation
  • Updates build process to inject documentation into WASM components during build

Reviewed Changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
crates/wassette/src/lib.rs Updates ComponentInstance to store package docs and use docs-aware schema generation
crates/component2json/src/lib.rs Adds core functionality for extracting and using package docs in schema generation
crates/component2json/cmd/main.rs Updates CLI tool to use package docs when available
crates/component2json/Cargo.toml Adds wasmparser and wat dependencies for WASM parsing and testing
Justfile Adds wit-docs-inject installation and doc injection steps to build process
.github/workflows/examples.yml Installs wit-docs-inject in CI workflow

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>
@Mossaka Mossaka force-pushed the mossaka/component-docs-take-2 branch from fd41a05 to ea4e417 Compare October 9, 2025 00:11
@Mossaka Mossaka merged commit f2da0fa into microsoft:main Oct 9, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants