feat: Agent Skill - #91
Conversation
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
…onditional uv install Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
-t text option for plain text citation output
… pip Co-authored-by: njzjz <9496702+njzjz@users.noreply.github.com>
-t text option for plain text citation outputUpdated output formats section to clarify default format and options.
for more information, see https://pre-commit.ci
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #91 +/- ##
=======================================
Coverage 87.10% 87.10%
=======================================
Files 12 12
Lines 504 504
=======================================
Hits 439 439
Misses 65 65 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This pull request implements an Agent Skill for wenxian, enabling AI assistants and IDEs to use wenxian for generating citations. The PR adds comprehensive documentation following the Agent Skills specification format and updates the main README to inform users about this new integration capability.
Changes:
- Added Agent Skill documentation (skill/SKILL.md) with comprehensive usage instructions, examples, and integration guidance
- Updated README.md to introduce the Agent Skill feature and provide installation instructions
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| skill/SKILL.md | New comprehensive Agent Skill documentation with YAML frontmatter, installation instructions, usage examples for all identifier types and output formats, troubleshooting guidance, and integration examples |
| README.md | Added new section documenting the Agent Skill feature, including links to supported platforms and usage example |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| 3. **Save to file**: Redirect output to a .bib file | ||
| ```bash | ||
| uvx wenxian from "10.1038/nature12373" >> references.bib |
There was a problem hiding this comment.
Inconsistent quoting of DOI identifier. Line 131 uses quotes around the DOI "10.1038/nature12373", but the "Using DOI" example at line 49 shows DOI identifiers without quotes. For consistency with line 49 and the guidance at line 72 (quotes are for titles with spaces), consider removing quotes from this DOI identifier.
| uvx wenxian from "10.1038/nature12373" >> references.bib | |
| uvx wenxian from 10.1038/nature12373 >> references.bib |
|
|
||
| It is expected to see a ${\mathrm{B{\scriptstyle{IB}} T_{\displaystyle E} X}}$ entry printed into the standard output. | ||
|
|
||
| By default, `wenxian` outputs ${\mathrm{B{\scriptstyle{IB}} T_{\displaystyle E} X}}$ format. You can use the `-t text` or `--type text` option to generate plain text format. |
There was a problem hiding this comment.
Incomplete documentation of output formats. The text only mentions -t text option but wenxian also supports -t markdown format (as shown in skill/SKILL.md and confirmed in the source code wenxian/main.py). Consider mentioning all available formats: bibtex (default), text, and markdown, or at least indicate that other formats are available.
| By default, `wenxian` outputs ${\mathrm{B{\scriptstyle{IB}} T_{\displaystyle E} X}}$ format. You can use the `-t text` or `--type text` option to generate plain text format. | |
| By default, `wenxian` outputs ${\mathrm{B{\scriptstyle{IB}} T_{\displaystyle E} X}}$ format. You can use the `-t text` or `--type text` option to generate plain text format, or `-t markdown` / `--type markdown` to generate Markdown format. |
| uvx wenxian from "10.1038/nature12373" | ||
| ``` | ||
|
|
||
| 2. **Multiple citations**: Generate entries for multiple papers by running the command multiple times | ||
|
|
||
| ```bash | ||
| uvx wenxian from "10.1038/nature12373" | ||
| uvx wenxian from "10.1126/science.1158899" | ||
| ``` | ||
|
|
||
| 3. **Save to file**: Redirect output to a .bib file | ||
| ```bash | ||
| uvx wenxian from "10.1038/nature12373" >> references.bib |
There was a problem hiding this comment.
Inconsistent quoting of DOI identifiers. Lines 119, 125, 126, 131, and 183 use quotes around DOI identifiers (e.g., "10.1038/nature12373"), but lines 49 and 171 show DOI identifiers without quotes. According to line 72, quotes are only required for paper titles with spaces. For consistency with the "Using DOI" example at line 49 and the guidance at line 72, consider removing quotes from DOI identifiers in these examples, or add a note explaining when quotes are needed.
| uvx wenxian from "10.1038/nature12373" | |
| ``` | |
| 2. **Multiple citations**: Generate entries for multiple papers by running the command multiple times | |
| ```bash | |
| uvx wenxian from "10.1038/nature12373" | |
| uvx wenxian from "10.1126/science.1158899" | |
| ``` | |
| 3. **Save to file**: Redirect output to a .bib file | |
| ```bash | |
| uvx wenxian from "10.1038/nature12373" >> references.bib | |
| uvx wenxian from 10.1038/nature12373 |
-
Multiple citations: Generate entries for multiple papers by running the command multiple times
uvx wenxian from 10.1038/nature12373 uvx wenxian from 10.1126/science.1158899
-
Save to file: Redirect output to a .bib file
uvx wenxian from 10.1038/nature12373 >> references.bib
| uvx wenxian from "10.1038/nature12373" >> references.bib | ||
| uvx wenxian from "1512.03385" >> references.bib |
There was a problem hiding this comment.
Inconsistent quoting of identifiers. Lines 183-184 use quotes around DOI and arXiv identifiers in the batch processing example, but earlier examples consistently show these numeric identifiers without quotes (lines 49, 55, 81). For consistency with the rest of the documentation and the guidance at line 72 (quotes are for titles with spaces), consider removing quotes from these identifiers.
| uvx wenxian from "10.1038/nature12373" >> references.bib | |
| uvx wenxian from "1512.03385" >> references.bib | |
| uvx wenxian from 10.1038/nature12373 >> references.bib | |
| uvx wenxian from 1512.03385 >> references.bib |
Original prompt