azure-typespec-assessment
Skill135 starsChanged 2 months agoMITView on GitHub
Assess Azure TypeSpec Git diffs for semantic intent, REST and downstream SDK breaking changes, Azure Guidelines compliance, and documentation completeness. Generate a read-only assessment without modifying the TypeSpec source. WHEN: "assess TypeSpec changes", "review TypeSpec diff", "check TypeSpec breaking changes", "assess TypeSpec against Azure Guidelines", "explain TypeSpec REST impact", "review TypeSpec documentation". DO NOT USE FOR: editing, fixing, or otherwise modifying TypeSpec; use azure-typespec-author for authoring and remediation.
We split this skill into the rules it gives an agent
10 rules. About 0 are common, 5 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 16
Check whether the user explicitly supplied or confirmed the baseline for this assessment.
- Distinctive: line 19
Use the host's user-question tool when available and wait for the answer.
- Very specific: line 20
Do not start preflight, compute a merge base, create work artifacts, or run analysis before confirmation.
- Distinctive: line 23
Use a supplied baseline without asking again.
- Distinctive: line 34
Follow the complete workflow.
- Distinctive: line 38
After guarded finalization succeeds, the assessment is not complete until the rendered report is served and linked:
- Very specific: line 51
Do not substitute a file: URL or only return filesystem paths.
- Very specific: line 56
Run complete mode only: merge-base through HEAD, staged, unstaged, and relevant untracked changes.
- Very specific: line 58
Check deterministic hunk coverage in model-input.json.
- Very specific: line 62
Treat a completed search with no governing guidance as no-applicable-guidance.
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Azure TypeSpec Assessment
Assess only the user-selected TypeSpec scope, normally before a PR exists. Never modify the user's assessed source, branch, index, or working tree; isolated temporary sparse worktrees and artifacts are allowed only under the chosen work directory.
Before starting a local assessment
Check whether the user explicitly supplied or confirmed the baseline for this
assessment. If not, your first assessment action must be to ask:
"Compare against origin/main, or a different branch or commit?"
Use the host's user-question tool when available and wait for the answer.
Do not start preflight, compute a merge base, create work artifacts, or run
analysis before confirmation. Permission to assess the code is not permission
to choose its baseline; merely announcing origin/main is not confirmation.
Use a supplied baseline without asking again. Existing-report replay does not
need this question; for PR assessment, use the PR's actual target baseline.
For every fresh assessment, the coordinator is the first operational command.
For a PR, run run-assessment-analysis.ts --pr <url-or-number> --repo <repo>
--output <work> immediately. For local code, run it immediately with
--base, --specification, --repo, and --output once the baseline is
known. Do not run separate Git status/diff/fetch/worktree, PR metadata,
dependency, or project-discovery commands first. Diagnose only a concrete
blocker returned by the coordinator.
Follow the complete workflow. Apply the classification rules, including the detailed downstream cases, perform the Azure Guidelines search against the official document catalog, check documentation completeness, and produce exactly the required outputs.
Required completion
After guarded finalization succeeds, the assessment is not complete until the rendered report is served and linked:
- Start
scripts/serve-assessment.ts --file <work-directory>/assessment.htmlthrough the host's attached background or long-lived process mechanism. - Immediately read startup output from the running process through the host's process-output reader. Do not wait for process completion or a completion notification: the server is intentionally long-lived.
- Capture the printed
http://127.0.0.1:<port>/assessment.htmlURL and confirm the process remains running. - Return that URL as the clickable Assessment report link and include the
absolute
assessment.jsonpath for structured results.
Do not substitute a file: URL or only return filesystem paths.
Boundaries
- V1 is standalone and opt-in: run only when the user explicitly requests an assessment or review. Do not invoke this skill from
azure-typespec-author, or automatically before or after its authoring and validation workflow. Integration is deferred to a future version. - Run complete mode only: merge-base through
HEAD, staged, unstaged, and relevant untracked changes. - Derive semantic intents from changed TypeSpec source. Use AutoRest only to map those intents to REST operations and assess REST compatibility; use TCGC only for downstream SDK analysis.
- Check deterministic hunk coverage in
model-input.json. Resolve only its declaredartifactReferencesandevidenceSetIdentries when full evidence is needed. Skip inference when all hunks have candidates or explicit deterministic classifications. Forunknownhunks only, write and validateinference.jsonbefore final judgment. - When the coordinator returns
awaiting-agent-judgment, continue immediately in the same task. Do not stop for a progress summary or require the user to say "continue." Readagent-workspace/agent-index.jsononce, then read its single boundedmodel-input.jsonexactly once. Read the compact decision schema listed in the index exactly once, resolving it relative to this skill directory; do not search for schemas. Do not recursively list the work directory, scan canonical artifacts broadly, or reread schemas during normal execution. api-version-publicationandapi-version-wide-changeintents are deterministic informational items. A version-wide change is identified from aVersionsdeclaration with no directly owned operation and only version-transition/governance operation mappings; it does not use an operation-count threshold. Their affected operations remain in the final Semantic intents report, but they and their exclusively associated candidates are excluded from model input, inference, Azure Guidelines decisions, breaking-change relationships, and findings.- In the final bounded Agent phase, summarize each assessed Semantic intent once, judge every deterministic and inferred REST/downstream candidate, rank the catalog once across all assessed Semantic intents, fetch four official documents once with ranked fallback, record provenance and extracted guidance once, then assess each included intent against that shared document set. Guidance excerpts do not carry declaration IDs; use only the prefilled intent-scoped qualified
declarationNamesin the citing compliance judgment. Write onlyagent-workspace/agent-decisions.json; run the indexed materializer to produce inference, search-evidence, and judgment artifacts. The materializer never fetches or authors judgment. Do not assess each operation or invent URLs, operations, symbols, sources, or guidance. - Treat a completed search with no governing guidance as
no-applicable-guidance; count it as assessed and do not create a blocker. Reservenot-assessedfor an incomplete or blocked Azure Guidelines assessment. - Check documentation deterministically from compiler results only for newly added operation, model, enum, and interface declarations. A declaration is complete when the compiler returns a nonempty effective document, including inherited documentation. Missing or empty documentation creates a finding with the exact TypeSpec declaration. Never compare documentation text with code or send documentation to the Agent.
- Report Azure Guidelines and Documentation Completeness independently with explicit coverage. Documentation with no eligible newly added declarations is
not-applicable; unavailable compiler evidence remainsnot-assessed. - Overall safety covers REST and downstream SDK impact only.
- After successful materialization, run one guarded invocation of
finalize-assessment.ts --work <work-directory>. Do not separately assemble, validate, and render. Finalization requires validatedassessment.jsonandassessment.html; user-facing completion additionally requires the served report link described above.model-input.json, the Agent index, filesystem paths without the link, or a partial blocker is not completion. - Retain blockers as Potential limits in the report appendix and stop after assessment. Do not author fixes or remediate TypeSpec.
In this repository43 other files it gives its agents.
- packages/python-packages/apiview-copilot/AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- azsdk-common-apiview-feedback-resolutionSkill
- azsdk-common-generate-sdk-locallySkill
- azsdk-common-generate-sdk-pipelineSkill
- azsdk-common-pipeline-analysisSkill
- azsdk-common-pipeline-fixerSkill
- azsdk-common-prepare-release-planSkill
- azsdk-common-sdk-breaking-changeSkill
- azsdk-common-sdk-releaseSkill
- azsdk-common-typespec-namingSkill
- azure-typespec-authorSkill
- code-reviewSkill
- eval-authoring-skillSkill
- eval-authoring-toolSkill
- eval-authoring-workflowSkill
- markdown-token-optimizerSkill
- sdk-ai-bot-eval-datasetSkill
- sdk-ai-bot-run-evaluationSkill
- skill-authoringSkill
- add-endpointSkill
- audit-filtersSkill
- dev-setupSkill
- kb-searchSkill
- report-active-reviewsSkill
- report-apiview-metricsSkill
- report-architect-commentsSkill
- report-feedbackSkill
- report-memorySkill
- report-revisionsSkill
- run-evalsSkill
- run-metricsSkill
- update-guidelinesSkill
- apiview-feedback-resolutionSkill
- azure-typespec-authorSkill
- generate-sdk-locallySkill
- azsdk-common-live-and-recorded-testsSkill
- markdown-token-optimizerSkill
- pipeline-troubleshootingSkill
- azsdk-common-prepare-release-planSkill
- azsdk-common-sdk-releaseSkill
- skill-authoringSkill
- pr-review-helpSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

