Skip to content

docs: Add agent-docs for LLM/AI context#82

Merged
HasanAboShally merged 2 commits intomicrosoft:mainfrom
data-goblin:fabric-cli-context-files
Feb 8, 2026
Merged

docs: Add agent-docs for LLM/AI context#82
HasanAboShally merged 2 commits intomicrosoft:mainfrom
data-goblin:fabric-cli-context-files

Conversation

@data-goblin
Copy link
Contributor

Description of new changes

  • Summary: Adds docs/agent-docs/ directory containing context files for LLM/AI agents using the fab CLI. These markdown files provide structured guidance, command references, and workflow examples optimized for AI assistants. They are structured according to the Claude Code skill format. While the skill format is proprietary, the use of it is not.

  • Context: AI coding assistants (Claude, Copilot, etc.) benefit from structured context files when working with CLI tools. These docs should help agents understand fab CLI syntax, common workflows, etc. They're focused on my use-cases, tho.

  • Dependencies: None. These are standalone markdown documentation files. I've provided them also in a Claude Code Plugin which you can find here, which also contains a small MCP server that wraps the CLI, and some helper scripts that extend its functionality.

Files added

  • SKILL.md - Main context file with command reference, core concepts, and common workflows
  • references/ - Detailed guides for specific topics:
    • quickstart.md - Copy-paste examples for common operations
    • reference.md - Full command reference
    • semantic-models.md - TMDL, DAX, refresh operations
    • notebooks.md - Job execution and scheduling
    • workspaces.md - Workspace management
    • reports.md - Report operations
    • fab-api.md - Direct API access patterns
    • querying-data.md - DAX and SQL endpoint queries
    • create-workspaces.md - Workspace creation patterns

@aliabufoul
Copy link
Collaborator

Can you please elaborate on how users will benefit from these references?
Trying to understand the E2E experience of users utilizing this reference for better agent experience. And how it relates to the plugin you shared in case we wanted to distribute this skill as a plugin for Claude?

@aliabufoul aliabufoul added the needs author feedback Issue requires more information from author label Dec 4, 2025
jeremydhoover-blip pushed a commit to jeremydhoover-blip/fabric-cli that referenced this pull request Jan 7, 2026
- Add .github/agents.md following agents.md best practices (https://agents.md/)
- Delete copilot-instructions.md (replaced by agents.md)
- Reference docs/agent-docs/SKILL.md from PR microsoft#82
- All content from copilot-instructions.md preserved and enhanced
- Follows modern GitHub agents.md format with clear structure
- References detailed agent documentation instead of embedding everything
@ayeshurun ayeshurun changed the title Docs: Add agent-docs for LLM/AI context docs: Add agent-docs for LLM/AI context Feb 8, 2026
@ayeshurun ayeshurun added skip-changelog and removed needs author feedback Issue requires more information from author labels Feb 8, 2026
@HasanAboShally HasanAboShally merged commit 5e6f5de into microsoft:main Feb 8, 2026
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants