chore: sync workspace updates
This commit is contained in:
parent
a013abb3c4
commit
89eeb449b5
0
.zhouyanbo
Normal file
0
.zhouyanbo
Normal file
202
agentskills/skill-creator/LICENSE.txt
Normal file
202
agentskills/skill-creator/LICENSE.txt
Normal file
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
357
agentskills/skill-creator/SKILL.md
Normal file
357
agentskills/skill-creator/SKILL.md
Normal file
@ -0,0 +1,357 @@
|
||||
---
|
||||
name: skill-creator
|
||||
description: Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.
|
||||
license: Complete terms in LICENSE.txt
|
||||
---
|
||||
|
||||
# Skill Creator
|
||||
|
||||
This skill provides guidance for creating effective skills.
|
||||
|
||||
## About Skills
|
||||
|
||||
Skills are modular, self-contained packages that extend Claude's capabilities by providing
|
||||
specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific
|
||||
domains or tasks—they transform Claude from a general-purpose agent into a specialized agent
|
||||
equipped with procedural knowledge that no model can fully possess.
|
||||
|
||||
### What Skills Provide
|
||||
|
||||
1. Specialized workflows - Multi-step procedures for specific domains
|
||||
2. Tool integrations - Instructions for working with specific file formats or APIs
|
||||
3. Domain expertise - Company-specific knowledge, schemas, business logic
|
||||
4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks
|
||||
|
||||
## Core Principles
|
||||
|
||||
### Concise is Key
|
||||
|
||||
The context window is a public good. Skills share the context window with everything else Claude needs: system prompt, conversation history, other Skills' metadata, and the actual user request.
|
||||
|
||||
**Default assumption: Claude is already very smart.** Only add context Claude doesn't already have. Challenge each piece of information: "Does Claude really need this explanation?" and "Does this paragraph justify its token cost?"
|
||||
|
||||
Prefer concise examples over verbose explanations.
|
||||
|
||||
### Set Appropriate Degrees of Freedom
|
||||
|
||||
Match the level of specificity to the task's fragility and variability:
|
||||
|
||||
**High freedom (text-based instructions)**: Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.
|
||||
|
||||
**Medium freedom (pseudocode or scripts with parameters)**: Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.
|
||||
|
||||
**Low freedom (specific scripts, few parameters)**: Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.
|
||||
|
||||
Think of Claude as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).
|
||||
|
||||
### Anatomy of a Skill
|
||||
|
||||
Every skill consists of a required SKILL.md file and optional bundled resources:
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md (required)
|
||||
│ ├── YAML frontmatter metadata (required)
|
||||
│ │ ├── name: (required)
|
||||
│ │ ├── description: (required)
|
||||
│ │ └── compatibility: (optional, rarely needed)
|
||||
│ └── Markdown instructions (required)
|
||||
└── Bundled Resources (optional)
|
||||
├── scripts/ - Executable code (Python/Bash/etc.)
|
||||
├── references/ - Documentation intended to be loaded into context as needed
|
||||
└── assets/ - Files used in output (templates, icons, fonts, etc.)
|
||||
```
|
||||
|
||||
#### SKILL.md (required)
|
||||
|
||||
Every SKILL.md consists of:
|
||||
|
||||
- **Frontmatter** (YAML): Contains `name` and `description` fields (required), plus optional fields like `license`, `metadata`, and `compatibility`. Only `name` and `description` are read by Claude to determine when the skill triggers, so be clear and comprehensive about what the skill is and when it should be used. The `compatibility` field is for noting environment requirements (target product, system packages, etc.) but most skills don't need it.
|
||||
- **Body** (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).
|
||||
|
||||
#### Bundled Resources (optional)
|
||||
|
||||
##### Scripts (`scripts/`)
|
||||
|
||||
Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
|
||||
|
||||
- **When to include**: When the same code is being rewritten repeatedly or deterministic reliability is needed
|
||||
- **Example**: `scripts/rotate_pdf.py` for PDF rotation tasks
|
||||
- **Benefits**: Token efficient, deterministic, may be executed without loading into context
|
||||
- **Note**: Scripts may still need to be read by Claude for patching or environment-specific adjustments
|
||||
|
||||
##### References (`references/`)
|
||||
|
||||
Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.
|
||||
|
||||
- **When to include**: For documentation that Claude should reference while working
|
||||
- **Examples**: `references/finance.md` for financial schemas, `references/mnda.md` for company NDA template, `references/policies.md` for company policies, `references/api_docs.md` for API specifications
|
||||
- **Use cases**: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
|
||||
- **Benefits**: Keeps SKILL.md lean, loaded only when Claude determines it's needed
|
||||
- **Best practice**: If files are large (>10k words), include grep search patterns in SKILL.md
|
||||
- **Avoid duplication**: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
|
||||
|
||||
##### Assets (`assets/`)
|
||||
|
||||
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
||||
|
||||
- **When to include**: When the skill needs files that will be used in the final output
|
||||
- **Examples**: `assets/logo.png` for brand assets, `assets/slides.pptx` for PowerPoint templates, `assets/frontend-template/` for HTML/React boilerplate, `assets/font.ttf` for typography
|
||||
- **Use cases**: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
|
||||
- **Benefits**: Separates output resources from documentation, enables Claude to use files without loading them into context
|
||||
|
||||
#### What to Not Include in a Skill
|
||||
|
||||
A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:
|
||||
|
||||
- README.md
|
||||
- INSTALLATION_GUIDE.md
|
||||
- QUICK_REFERENCE.md
|
||||
- CHANGELOG.md
|
||||
- etc.
|
||||
|
||||
The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxilary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.
|
||||
|
||||
### Progressive Disclosure Design Principle
|
||||
|
||||
Skills use a three-level loading system to manage context efficiently:
|
||||
|
||||
1. **Metadata (name + description)** - Always in context (~100 words)
|
||||
2. **SKILL.md body** - When skill triggers (<5k words)
|
||||
3. **Bundled resources** - As needed by Claude (Unlimited because scripts can be executed without reading into context window)
|
||||
|
||||
#### Progressive Disclosure Patterns
|
||||
|
||||
Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.
|
||||
|
||||
**Key principle:** When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.
|
||||
|
||||
**Pattern 1: High-level guide with references**
|
||||
|
||||
```markdown
|
||||
# PDF Processing
|
||||
|
||||
## Quick start
|
||||
|
||||
Extract text with pdfplumber:
|
||||
[code example]
|
||||
|
||||
## Advanced features
|
||||
|
||||
- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
|
||||
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
|
||||
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns
|
||||
```
|
||||
|
||||
Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.
|
||||
|
||||
**Pattern 2: Domain-specific organization**
|
||||
|
||||
For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:
|
||||
|
||||
```
|
||||
bigquery-skill/
|
||||
├── SKILL.md (overview and navigation)
|
||||
└── reference/
|
||||
├── finance.md (revenue, billing metrics)
|
||||
├── sales.md (opportunities, pipeline)
|
||||
├── product.md (API usage, features)
|
||||
└── marketing.md (campaigns, attribution)
|
||||
```
|
||||
|
||||
When a user asks about sales metrics, Claude only reads sales.md.
|
||||
|
||||
Similarly, for skills supporting multiple frameworks or variants, organize by variant:
|
||||
|
||||
```
|
||||
cloud-deploy/
|
||||
├── SKILL.md (workflow + provider selection)
|
||||
└── references/
|
||||
├── aws.md (AWS deployment patterns)
|
||||
├── gcp.md (GCP deployment patterns)
|
||||
└── azure.md (Azure deployment patterns)
|
||||
```
|
||||
|
||||
When the user chooses AWS, Claude only reads aws.md.
|
||||
|
||||
**Pattern 3: Conditional details**
|
||||
|
||||
Show basic content, link to advanced content:
|
||||
|
||||
```markdown
|
||||
# DOCX Processing
|
||||
|
||||
## Creating documents
|
||||
|
||||
Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).
|
||||
|
||||
## Editing documents
|
||||
|
||||
For simple edits, modify the XML directly.
|
||||
|
||||
**For tracked changes**: See [REDLINING.md](REDLINING.md)
|
||||
**For OOXML details**: See [OOXML.md](OOXML.md)
|
||||
```
|
||||
|
||||
Claude reads REDLINING.md or OOXML.md only when the user needs those features.
|
||||
|
||||
**Important guidelines:**
|
||||
|
||||
- **Avoid deeply nested references** - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
|
||||
- **Structure longer reference files** - For files longer than 100 lines, include a table of contents at the top so Claude can see the full scope when previewing.
|
||||
|
||||
## Skill Creation Process
|
||||
|
||||
Skill creation involves these steps:
|
||||
|
||||
1. Understand the skill with concrete examples
|
||||
2. Plan reusable skill contents (scripts, references, assets)
|
||||
3. Initialize the skill (run init_skill.py)
|
||||
4. Edit the skill (implement resources and write SKILL.md)
|
||||
5. Package the skill (run package_skill.py)
|
||||
6. Iterate based on real usage
|
||||
|
||||
Follow these steps in order, skipping only if there is a clear reason why they are not applicable.
|
||||
|
||||
### Step 1: Understanding the Skill with Concrete Examples
|
||||
|
||||
Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.
|
||||
|
||||
To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.
|
||||
|
||||
For example, when building an image-editor skill, relevant questions include:
|
||||
|
||||
- "What functionality should the image-editor skill support? Editing, rotating, anything else?"
|
||||
- "Can you give some examples of how this skill would be used?"
|
||||
- "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
|
||||
- "What would a user say that should trigger this skill?"
|
||||
|
||||
To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.
|
||||
|
||||
Conclude this step when there is a clear sense of the functionality the skill should support.
|
||||
|
||||
### Step 2: Planning the Reusable Skill Contents
|
||||
|
||||
To turn concrete examples into an effective skill, analyze each example by:
|
||||
|
||||
1. Considering how to execute on the example from scratch
|
||||
2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly
|
||||
|
||||
Example: When building a `pdf-editor` skill to handle queries like "Help me rotate this PDF," the analysis shows:
|
||||
|
||||
1. Rotating a PDF requires re-writing the same code each time
|
||||
2. A `scripts/rotate_pdf.py` script would be helpful to store in the skill
|
||||
|
||||
Example: When designing a `frontend-webapp-builder` skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:
|
||||
|
||||
1. Writing a frontend webapp requires the same boilerplate HTML/React each time
|
||||
2. An `assets/hello-world/` template containing the boilerplate HTML/React project files would be helpful to store in the skill
|
||||
|
||||
Example: When building a `big-query` skill to handle queries like "How many users have logged in today?" the analysis shows:
|
||||
|
||||
1. Querying BigQuery requires re-discovering the table schemas and relationships each time
|
||||
2. A `references/schema.md` file documenting the table schemas would be helpful to store in the skill
|
||||
|
||||
To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
|
||||
|
||||
### Step 3: Initializing the Skill
|
||||
|
||||
At this point, it is time to actually create the skill.
|
||||
|
||||
Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.
|
||||
|
||||
When creating a new skill from scratch, always run the `init_skill.py` script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
|
||||
|
||||
Usage:
|
||||
|
||||
```bash
|
||||
scripts/init_skill.py <skill-name> --path <output-directory>
|
||||
```
|
||||
|
||||
The script:
|
||||
|
||||
- Creates the skill directory at the specified path
|
||||
- Generates a SKILL.md template with proper frontmatter and TODO placeholders
|
||||
- Creates example resource directories: `scripts/`, `references/`, and `assets/`
|
||||
- Adds example files in each directory that can be customized or deleted
|
||||
|
||||
After initialization, customize or remove the generated SKILL.md and example files as needed.
|
||||
|
||||
### Step 4: Edit the Skill
|
||||
|
||||
When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Include information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.
|
||||
|
||||
#### Learn Proven Design Patterns
|
||||
|
||||
Consult these helpful guides based on your skill's needs:
|
||||
|
||||
- **Multi-step processes**: See references/workflows.md for sequential workflows and conditional logic
|
||||
- **Specific output formats or quality standards**: See references/output-patterns.md for template and example patterns
|
||||
|
||||
These files contain established best practices for effective skill design.
|
||||
|
||||
#### Start with Reusable Skill Contents
|
||||
|
||||
To begin implementation, start with the reusable resources identified above: `scripts/`, `references/`, and `assets/` files. Note that this step may require user input. For example, when implementing a `brand-guidelines` skill, the user may need to provide brand assets or templates to store in `assets/`, or documentation to store in `references/`.
|
||||
|
||||
Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.
|
||||
|
||||
Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in `scripts/`, `references/`, and `assets/` to demonstrate structure, but most skills won't need all of them.
|
||||
|
||||
#### Update SKILL.md
|
||||
|
||||
**Writing Guidelines:** Always use imperative/infinitive form.
|
||||
|
||||
##### Frontmatter
|
||||
|
||||
Write the YAML frontmatter with `name` and `description`:
|
||||
|
||||
- `name`: The skill name
|
||||
- `description`: This is the primary triggering mechanism for your skill, and helps Claude understand when to use the skill.
|
||||
- Include both what the Skill does and specific triggers/contexts for when to use it.
|
||||
- Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Claude.
|
||||
- Example description for a `docx` skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"
|
||||
|
||||
Do not include any other fields in YAML frontmatter.
|
||||
|
||||
##### Body
|
||||
|
||||
Write instructions for using the skill and its bundled resources.
|
||||
|
||||
### Step 5: Packaging a Skill
|
||||
|
||||
Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:
|
||||
|
||||
```bash
|
||||
scripts/package_skill.py <path/to/skill-folder>
|
||||
```
|
||||
|
||||
Optional output directory specification:
|
||||
|
||||
```bash
|
||||
scripts/package_skill.py <path/to/skill-folder> ./dist
|
||||
```
|
||||
|
||||
The packaging script will:
|
||||
|
||||
1. **Validate** the skill automatically, checking:
|
||||
|
||||
- YAML frontmatter format and required fields
|
||||
- Skill naming conventions and directory structure
|
||||
- Description completeness and quality
|
||||
- File organization and resource references
|
||||
|
||||
2. **Package** the skill if validation passes, creating a .skill file named after the skill (e.g., `my-skill.skill`) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.
|
||||
|
||||
If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.
|
||||
|
||||
### Step 6: Iterate
|
||||
|
||||
After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.
|
||||
|
||||
**Iteration workflow:**
|
||||
|
||||
1. Use the skill on real tasks
|
||||
2. Notice struggles or inefficiencies
|
||||
3. Identify how SKILL.md or bundled resources should be updated
|
||||
4. Implement changes and test again
|
||||
82
agentskills/skill-creator/references/output-patterns.md
Normal file
82
agentskills/skill-creator/references/output-patterns.md
Normal file
@ -0,0 +1,82 @@
|
||||
# Output Patterns
|
||||
|
||||
Use these patterns when skills need to produce consistent, high-quality output.
|
||||
|
||||
## Template Pattern
|
||||
|
||||
Provide templates for output format. Match the level of strictness to your needs.
|
||||
|
||||
**For strict requirements (like API responses or data formats):**
|
||||
|
||||
```markdown
|
||||
## Report structure
|
||||
|
||||
ALWAYS use this exact template structure:
|
||||
|
||||
# [Analysis Title]
|
||||
|
||||
## Executive summary
|
||||
[One-paragraph overview of key findings]
|
||||
|
||||
## Key findings
|
||||
- Finding 1 with supporting data
|
||||
- Finding 2 with supporting data
|
||||
- Finding 3 with supporting data
|
||||
|
||||
## Recommendations
|
||||
1. Specific actionable recommendation
|
||||
2. Specific actionable recommendation
|
||||
```
|
||||
|
||||
**For flexible guidance (when adaptation is useful):**
|
||||
|
||||
```markdown
|
||||
## Report structure
|
||||
|
||||
Here is a sensible default format, but use your best judgment:
|
||||
|
||||
# [Analysis Title]
|
||||
|
||||
## Executive summary
|
||||
[Overview]
|
||||
|
||||
## Key findings
|
||||
[Adapt sections based on what you discover]
|
||||
|
||||
## Recommendations
|
||||
[Tailor to the specific context]
|
||||
|
||||
Adjust sections as needed for the specific analysis type.
|
||||
```
|
||||
|
||||
## Examples Pattern
|
||||
|
||||
For skills where output quality depends on seeing examples, provide input/output pairs:
|
||||
|
||||
```markdown
|
||||
## Commit message format
|
||||
|
||||
Generate commit messages following these examples:
|
||||
|
||||
**Example 1:**
|
||||
Input: Added user authentication with JWT tokens
|
||||
Output:
|
||||
```
|
||||
feat(auth): implement JWT-based authentication
|
||||
|
||||
Add login endpoint and token validation middleware
|
||||
```
|
||||
|
||||
**Example 2:**
|
||||
Input: Fixed bug where dates displayed incorrectly in reports
|
||||
Output:
|
||||
```
|
||||
fix(reports): correct date formatting in timezone conversion
|
||||
|
||||
Use UTC timestamps consistently across report generation
|
||||
```
|
||||
|
||||
Follow this style: type(scope): brief description, then detailed explanation.
|
||||
```
|
||||
|
||||
Examples help Claude understand the desired style and level of detail more clearly than descriptions alone.
|
||||
28
agentskills/skill-creator/references/workflows.md
Normal file
28
agentskills/skill-creator/references/workflows.md
Normal file
@ -0,0 +1,28 @@
|
||||
# Workflow Patterns
|
||||
|
||||
## Sequential Workflows
|
||||
|
||||
For complex tasks, break operations into clear, sequential steps. It is often helpful to give Claude an overview of the process towards the beginning of SKILL.md:
|
||||
|
||||
```markdown
|
||||
Filling a PDF form involves these steps:
|
||||
|
||||
1. Analyze the form (run analyze_form.py)
|
||||
2. Create field mapping (edit fields.json)
|
||||
3. Validate mapping (run validate_fields.py)
|
||||
4. Fill the form (run fill_form.py)
|
||||
5. Verify output (run verify_output.py)
|
||||
```
|
||||
|
||||
## Conditional Workflows
|
||||
|
||||
For tasks with branching logic, guide Claude through decision points:
|
||||
|
||||
```markdown
|
||||
1. Determine the modification type:
|
||||
**Creating new content?** → Follow "Creation workflow" below
|
||||
**Editing existing content?** → Follow "Editing workflow" below
|
||||
|
||||
2. Creation workflow: [steps]
|
||||
3. Editing workflow: [steps]
|
||||
```
|
||||
303
agentskills/skill-creator/scripts/init_skill.py
Executable file
303
agentskills/skill-creator/scripts/init_skill.py
Executable file
@ -0,0 +1,303 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Skill Initializer - Creates a new skill from template
|
||||
|
||||
Usage:
|
||||
init_skill.py <skill-name> --path <path>
|
||||
|
||||
Examples:
|
||||
init_skill.py my-new-skill --path skills/public
|
||||
init_skill.py my-api-helper --path skills/private
|
||||
init_skill.py custom-skill --path /custom/location
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
SKILL_TEMPLATE = """---
|
||||
name: {skill_name}
|
||||
description: [TODO: Complete and informative explanation of what the skill does and when to use it. Include WHEN to use this skill - specific scenarios, file types, or tasks that trigger it.]
|
||||
---
|
||||
|
||||
# {skill_title}
|
||||
|
||||
## Overview
|
||||
|
||||
[TODO: 1-2 sentences explaining what this skill enables]
|
||||
|
||||
## Structuring This Skill
|
||||
|
||||
[TODO: Choose the structure that best fits this skill's purpose. Common patterns:
|
||||
|
||||
**1. Workflow-Based** (best for sequential processes)
|
||||
- Works well when there are clear step-by-step procedures
|
||||
- Example: DOCX skill with "Workflow Decision Tree" → "Reading" → "Creating" → "Editing"
|
||||
- Structure: ## Overview → ## Workflow Decision Tree → ## Step 1 → ## Step 2...
|
||||
|
||||
**2. Task-Based** (best for tool collections)
|
||||
- Works well when the skill offers different operations/capabilities
|
||||
- Example: PDF skill with "Quick Start" → "Merge PDFs" → "Split PDFs" → "Extract Text"
|
||||
- Structure: ## Overview → ## Quick Start → ## Task Category 1 → ## Task Category 2...
|
||||
|
||||
**3. Reference/Guidelines** (best for standards or specifications)
|
||||
- Works well for brand guidelines, coding standards, or requirements
|
||||
- Example: Brand styling with "Brand Guidelines" → "Colors" → "Typography" → "Features"
|
||||
- Structure: ## Overview → ## Guidelines → ## Specifications → ## Usage...
|
||||
|
||||
**4. Capabilities-Based** (best for integrated systems)
|
||||
- Works well when the skill provides multiple interrelated features
|
||||
- Example: Product Management with "Core Capabilities" → numbered capability list
|
||||
- Structure: ## Overview → ## Core Capabilities → ### 1. Feature → ### 2. Feature...
|
||||
|
||||
Patterns can be mixed and matched as needed. Most skills combine patterns (e.g., start with task-based, add workflow for complex operations).
|
||||
|
||||
Delete this entire "Structuring This Skill" section when done - it's just guidance.]
|
||||
|
||||
## [TODO: Replace with the first main section based on chosen structure]
|
||||
|
||||
[TODO: Add content here. See examples in existing skills:
|
||||
- Code samples for technical skills
|
||||
- Decision trees for complex workflows
|
||||
- Concrete examples with realistic user requests
|
||||
- References to scripts/templates/references as needed]
|
||||
|
||||
## Resources
|
||||
|
||||
This skill includes example resource directories that demonstrate how to organize different types of bundled resources:
|
||||
|
||||
### scripts/
|
||||
Executable code (Python/Bash/etc.) that can be run directly to perform specific operations.
|
||||
|
||||
**Examples from other skills:**
|
||||
- PDF skill: `fill_fillable_fields.py`, `extract_form_field_info.py` - utilities for PDF manipulation
|
||||
- DOCX skill: `document.py`, `utilities.py` - Python modules for document processing
|
||||
|
||||
**Appropriate for:** Python scripts, shell scripts, or any executable code that performs automation, data processing, or specific operations.
|
||||
|
||||
**Note:** Scripts may be executed without loading into context, but can still be read by Claude for patching or environment adjustments.
|
||||
|
||||
### references/
|
||||
Documentation and reference material intended to be loaded into context to inform Claude's process and thinking.
|
||||
|
||||
**Examples from other skills:**
|
||||
- Product management: `communication.md`, `context_building.md` - detailed workflow guides
|
||||
- BigQuery: API reference documentation and query examples
|
||||
- Finance: Schema documentation, company policies
|
||||
|
||||
**Appropriate for:** In-depth documentation, API references, database schemas, comprehensive guides, or any detailed information that Claude should reference while working.
|
||||
|
||||
### assets/
|
||||
Files not intended to be loaded into context, but rather used within the output Claude produces.
|
||||
|
||||
**Examples from other skills:**
|
||||
- Brand styling: PowerPoint template files (.pptx), logo files
|
||||
- Frontend builder: HTML/React boilerplate project directories
|
||||
- Typography: Font files (.ttf, .woff2)
|
||||
|
||||
**Appropriate for:** Templates, boilerplate code, document templates, images, icons, fonts, or any files meant to be copied or used in the final output.
|
||||
|
||||
---
|
||||
|
||||
**Any unneeded directories can be deleted.** Not every skill requires all three types of resources.
|
||||
"""
|
||||
|
||||
EXAMPLE_SCRIPT = '''#!/usr/bin/env python3
|
||||
"""
|
||||
Example helper script for {skill_name}
|
||||
|
||||
This is a placeholder script that can be executed directly.
|
||||
Replace with actual implementation or delete if not needed.
|
||||
|
||||
Example real scripts from other skills:
|
||||
- pdf/scripts/fill_fillable_fields.py - Fills PDF form fields
|
||||
- pdf/scripts/convert_pdf_to_images.py - Converts PDF pages to images
|
||||
"""
|
||||
|
||||
def main():
|
||||
print("This is an example script for {skill_name}")
|
||||
# TODO: Add actual script logic here
|
||||
# This could be data processing, file conversion, API calls, etc.
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
'''
|
||||
|
||||
EXAMPLE_REFERENCE = """# Reference Documentation for {skill_title}
|
||||
|
||||
This is a placeholder for detailed reference documentation.
|
||||
Replace with actual reference content or delete if not needed.
|
||||
|
||||
Example real reference docs from other skills:
|
||||
- product-management/references/communication.md - Comprehensive guide for status updates
|
||||
- product-management/references/context_building.md - Deep-dive on gathering context
|
||||
- bigquery/references/ - API references and query examples
|
||||
|
||||
## When Reference Docs Are Useful
|
||||
|
||||
Reference docs are ideal for:
|
||||
- Comprehensive API documentation
|
||||
- Detailed workflow guides
|
||||
- Complex multi-step processes
|
||||
- Information too lengthy for main SKILL.md
|
||||
- Content that's only needed for specific use cases
|
||||
|
||||
## Structure Suggestions
|
||||
|
||||
### API Reference Example
|
||||
- Overview
|
||||
- Authentication
|
||||
- Endpoints with examples
|
||||
- Error codes
|
||||
- Rate limits
|
||||
|
||||
### Workflow Guide Example
|
||||
- Prerequisites
|
||||
- Step-by-step instructions
|
||||
- Common patterns
|
||||
- Troubleshooting
|
||||
- Best practices
|
||||
"""
|
||||
|
||||
EXAMPLE_ASSET = """# Example Asset File
|
||||
|
||||
This placeholder represents where asset files would be stored.
|
||||
Replace with actual asset files (templates, images, fonts, etc.) or delete if not needed.
|
||||
|
||||
Asset files are NOT intended to be loaded into context, but rather used within
|
||||
the output Claude produces.
|
||||
|
||||
Example asset files from other skills:
|
||||
- Brand guidelines: logo.png, slides_template.pptx
|
||||
- Frontend builder: hello-world/ directory with HTML/React boilerplate
|
||||
- Typography: custom-font.ttf, font-family.woff2
|
||||
- Data: sample_data.csv, test_dataset.json
|
||||
|
||||
## Common Asset Types
|
||||
|
||||
- Templates: .pptx, .docx, boilerplate directories
|
||||
- Images: .png, .jpg, .svg, .gif
|
||||
- Fonts: .ttf, .otf, .woff, .woff2
|
||||
- Boilerplate code: Project directories, starter files
|
||||
- Icons: .ico, .svg
|
||||
- Data files: .csv, .json, .xml, .yaml
|
||||
|
||||
Note: This is a text placeholder. Actual assets can be any file type.
|
||||
"""
|
||||
|
||||
|
||||
def title_case_skill_name(skill_name):
|
||||
"""Convert hyphenated skill name to Title Case for display."""
|
||||
return ' '.join(word.capitalize() for word in skill_name.split('-'))
|
||||
|
||||
|
||||
def init_skill(skill_name, path):
|
||||
"""
|
||||
Initialize a new skill directory with template SKILL.md.
|
||||
|
||||
Args:
|
||||
skill_name: Name of the skill
|
||||
path: Path where the skill directory should be created
|
||||
|
||||
Returns:
|
||||
Path to created skill directory, or None if error
|
||||
"""
|
||||
# Determine skill directory path
|
||||
skill_dir = Path(path).resolve() / skill_name
|
||||
|
||||
# Check if directory already exists
|
||||
if skill_dir.exists():
|
||||
print(f"❌ Error: Skill directory already exists: {skill_dir}")
|
||||
return None
|
||||
|
||||
# Create skill directory
|
||||
try:
|
||||
skill_dir.mkdir(parents=True, exist_ok=False)
|
||||
print(f"✅ Created skill directory: {skill_dir}")
|
||||
except Exception as e:
|
||||
print(f"❌ Error creating directory: {e}")
|
||||
return None
|
||||
|
||||
# Create SKILL.md from template
|
||||
skill_title = title_case_skill_name(skill_name)
|
||||
skill_content = SKILL_TEMPLATE.format(
|
||||
skill_name=skill_name,
|
||||
skill_title=skill_title
|
||||
)
|
||||
|
||||
skill_md_path = skill_dir / 'SKILL.md'
|
||||
try:
|
||||
skill_md_path.write_text(skill_content)
|
||||
print("✅ Created SKILL.md")
|
||||
except Exception as e:
|
||||
print(f"❌ Error creating SKILL.md: {e}")
|
||||
return None
|
||||
|
||||
# Create resource directories with example files
|
||||
try:
|
||||
# Create scripts/ directory with example script
|
||||
scripts_dir = skill_dir / 'scripts'
|
||||
scripts_dir.mkdir(exist_ok=True)
|
||||
example_script = scripts_dir / 'example.py'
|
||||
example_script.write_text(EXAMPLE_SCRIPT.format(skill_name=skill_name))
|
||||
example_script.chmod(0o755)
|
||||
print("✅ Created scripts/example.py")
|
||||
|
||||
# Create references/ directory with example reference doc
|
||||
references_dir = skill_dir / 'references'
|
||||
references_dir.mkdir(exist_ok=True)
|
||||
example_reference = references_dir / 'api_reference.md'
|
||||
example_reference.write_text(EXAMPLE_REFERENCE.format(skill_title=skill_title))
|
||||
print("✅ Created references/api_reference.md")
|
||||
|
||||
# Create assets/ directory with example asset placeholder
|
||||
assets_dir = skill_dir / 'assets'
|
||||
assets_dir.mkdir(exist_ok=True)
|
||||
example_asset = assets_dir / 'example_asset.txt'
|
||||
example_asset.write_text(EXAMPLE_ASSET)
|
||||
print("✅ Created assets/example_asset.txt")
|
||||
except Exception as e:
|
||||
print(f"❌ Error creating resource directories: {e}")
|
||||
return None
|
||||
|
||||
# Print next steps
|
||||
print(f"\n✅ Skill '{skill_name}' initialized successfully at {skill_dir}")
|
||||
print("\nNext steps:")
|
||||
print("1. Edit SKILL.md to complete the TODO items and update the description")
|
||||
print("2. Customize or delete the example files in scripts/, references/, and assets/")
|
||||
print("3. Run the validator when ready to check the skill structure")
|
||||
|
||||
return skill_dir
|
||||
|
||||
|
||||
def main():
|
||||
if len(sys.argv) < 4 or sys.argv[2] != '--path':
|
||||
print("Usage: init_skill.py <skill-name> --path <path>")
|
||||
print("\nSkill name requirements:")
|
||||
print(" - Kebab-case identifier (e.g., 'my-data-analyzer')")
|
||||
print(" - Lowercase letters, digits, and hyphens only")
|
||||
print(" - Max 64 characters")
|
||||
print(" - Must match directory name exactly")
|
||||
print("\nExamples:")
|
||||
print(" init_skill.py my-new-skill --path skills/public")
|
||||
print(" init_skill.py my-api-helper --path skills/private")
|
||||
print(" init_skill.py custom-skill --path /custom/location")
|
||||
sys.exit(1)
|
||||
|
||||
skill_name = sys.argv[1]
|
||||
path = sys.argv[3]
|
||||
|
||||
print(f"🚀 Initializing skill: {skill_name}")
|
||||
print(f" Location: {path}")
|
||||
print()
|
||||
|
||||
result = init_skill(skill_name, path)
|
||||
|
||||
if result:
|
||||
sys.exit(0)
|
||||
else:
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
110
agentskills/skill-creator/scripts/package_skill.py
Executable file
110
agentskills/skill-creator/scripts/package_skill.py
Executable file
@ -0,0 +1,110 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Skill Packager - Creates a distributable .skill file of a skill folder
|
||||
|
||||
Usage:
|
||||
python utils/package_skill.py <path/to/skill-folder> [output-directory]
|
||||
|
||||
Example:
|
||||
python utils/package_skill.py skills/public/my-skill
|
||||
python utils/package_skill.py skills/public/my-skill ./dist
|
||||
"""
|
||||
|
||||
import sys
|
||||
import zipfile
|
||||
from pathlib import Path
|
||||
from quick_validate import validate_skill
|
||||
|
||||
|
||||
def package_skill(skill_path, output_dir=None):
|
||||
"""
|
||||
Package a skill folder into a .skill file.
|
||||
|
||||
Args:
|
||||
skill_path: Path to the skill folder
|
||||
output_dir: Optional output directory for the .skill file (defaults to current directory)
|
||||
|
||||
Returns:
|
||||
Path to the created .skill file, or None if error
|
||||
"""
|
||||
skill_path = Path(skill_path).resolve()
|
||||
|
||||
# Validate skill folder exists
|
||||
if not skill_path.exists():
|
||||
print(f"❌ Error: Skill folder not found: {skill_path}")
|
||||
return None
|
||||
|
||||
if not skill_path.is_dir():
|
||||
print(f"❌ Error: Path is not a directory: {skill_path}")
|
||||
return None
|
||||
|
||||
# Validate SKILL.md exists
|
||||
skill_md = skill_path / "SKILL.md"
|
||||
if not skill_md.exists():
|
||||
print(f"❌ Error: SKILL.md not found in {skill_path}")
|
||||
return None
|
||||
|
||||
# Run validation before packaging
|
||||
print("🔍 Validating skill...")
|
||||
valid, message = validate_skill(skill_path)
|
||||
if not valid:
|
||||
print(f"❌ Validation failed: {message}")
|
||||
print(" Please fix the validation errors before packaging.")
|
||||
return None
|
||||
print(f"✅ {message}\n")
|
||||
|
||||
# Determine output location
|
||||
skill_name = skill_path.name
|
||||
if output_dir:
|
||||
output_path = Path(output_dir).resolve()
|
||||
output_path.mkdir(parents=True, exist_ok=True)
|
||||
else:
|
||||
output_path = Path.cwd()
|
||||
|
||||
skill_filename = output_path / f"{skill_name}.skill"
|
||||
|
||||
# Create the .skill file (zip format)
|
||||
try:
|
||||
with zipfile.ZipFile(skill_filename, 'w', zipfile.ZIP_DEFLATED) as zipf:
|
||||
# Walk through the skill directory
|
||||
for file_path in skill_path.rglob('*'):
|
||||
if file_path.is_file():
|
||||
# Calculate the relative path within the zip
|
||||
arcname = file_path.relative_to(skill_path.parent)
|
||||
zipf.write(file_path, arcname)
|
||||
print(f" Added: {arcname}")
|
||||
|
||||
print(f"\n✅ Successfully packaged skill to: {skill_filename}")
|
||||
return skill_filename
|
||||
|
||||
except Exception as e:
|
||||
print(f"❌ Error creating .skill file: {e}")
|
||||
return None
|
||||
|
||||
|
||||
def main():
|
||||
if len(sys.argv) < 2:
|
||||
print("Usage: python utils/package_skill.py <path/to/skill-folder> [output-directory]")
|
||||
print("\nExample:")
|
||||
print(" python utils/package_skill.py skills/public/my-skill")
|
||||
print(" python utils/package_skill.py skills/public/my-skill ./dist")
|
||||
sys.exit(1)
|
||||
|
||||
skill_path = sys.argv[1]
|
||||
output_dir = sys.argv[2] if len(sys.argv) > 2 else None
|
||||
|
||||
print(f"📦 Packaging skill: {skill_path}")
|
||||
if output_dir:
|
||||
print(f" Output directory: {output_dir}")
|
||||
print()
|
||||
|
||||
result = package_skill(skill_path, output_dir)
|
||||
|
||||
if result:
|
||||
sys.exit(0)
|
||||
else:
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
103
agentskills/skill-creator/scripts/quick_validate.py
Executable file
103
agentskills/skill-creator/scripts/quick_validate.py
Executable file
@ -0,0 +1,103 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Quick validation script for skills - minimal version
|
||||
"""
|
||||
|
||||
import sys
|
||||
import os
|
||||
import re
|
||||
import yaml
|
||||
from pathlib import Path
|
||||
|
||||
def validate_skill(skill_path):
|
||||
"""Basic validation of a skill"""
|
||||
skill_path = Path(skill_path)
|
||||
|
||||
# Check SKILL.md exists
|
||||
skill_md = skill_path / 'SKILL.md'
|
||||
if not skill_md.exists():
|
||||
return False, "SKILL.md not found"
|
||||
|
||||
# Read and validate frontmatter
|
||||
content = skill_md.read_text()
|
||||
if not content.startswith('---'):
|
||||
return False, "No YAML frontmatter found"
|
||||
|
||||
# Extract frontmatter
|
||||
match = re.match(r'^---\n(.*?)\n---', content, re.DOTALL)
|
||||
if not match:
|
||||
return False, "Invalid frontmatter format"
|
||||
|
||||
frontmatter_text = match.group(1)
|
||||
|
||||
# Parse YAML frontmatter
|
||||
try:
|
||||
frontmatter = yaml.safe_load(frontmatter_text)
|
||||
if not isinstance(frontmatter, dict):
|
||||
return False, "Frontmatter must be a YAML dictionary"
|
||||
except yaml.YAMLError as e:
|
||||
return False, f"Invalid YAML in frontmatter: {e}"
|
||||
|
||||
# Define allowed properties
|
||||
ALLOWED_PROPERTIES = {'name', 'description', 'license', 'allowed-tools', 'metadata', 'compatibility'}
|
||||
|
||||
# Check for unexpected properties (excluding nested keys under metadata)
|
||||
unexpected_keys = set(frontmatter.keys()) - ALLOWED_PROPERTIES
|
||||
if unexpected_keys:
|
||||
return False, (
|
||||
f"Unexpected key(s) in SKILL.md frontmatter: {', '.join(sorted(unexpected_keys))}. "
|
||||
f"Allowed properties are: {', '.join(sorted(ALLOWED_PROPERTIES))}"
|
||||
)
|
||||
|
||||
# Check required fields
|
||||
if 'name' not in frontmatter:
|
||||
return False, "Missing 'name' in frontmatter"
|
||||
if 'description' not in frontmatter:
|
||||
return False, "Missing 'description' in frontmatter"
|
||||
|
||||
# Extract name for validation
|
||||
name = frontmatter.get('name', '')
|
||||
if not isinstance(name, str):
|
||||
return False, f"Name must be a string, got {type(name).__name__}"
|
||||
name = name.strip()
|
||||
if name:
|
||||
# Check naming convention (kebab-case: lowercase with hyphens)
|
||||
if not re.match(r'^[a-z0-9-]+$', name):
|
||||
return False, f"Name '{name}' should be kebab-case (lowercase letters, digits, and hyphens only)"
|
||||
if name.startswith('-') or name.endswith('-') or '--' in name:
|
||||
return False, f"Name '{name}' cannot start/end with hyphen or contain consecutive hyphens"
|
||||
# Check name length (max 64 characters per spec)
|
||||
if len(name) > 64:
|
||||
return False, f"Name is too long ({len(name)} characters). Maximum is 64 characters."
|
||||
|
||||
# Extract and validate description
|
||||
description = frontmatter.get('description', '')
|
||||
if not isinstance(description, str):
|
||||
return False, f"Description must be a string, got {type(description).__name__}"
|
||||
description = description.strip()
|
||||
if description:
|
||||
# Check for angle brackets
|
||||
if '<' in description or '>' in description:
|
||||
return False, "Description cannot contain angle brackets (< or >)"
|
||||
# Check description length (max 1024 characters per spec)
|
||||
if len(description) > 1024:
|
||||
return False, f"Description is too long ({len(description)} characters). Maximum is 1024 characters."
|
||||
|
||||
# Validate compatibility field if present (optional)
|
||||
compatibility = frontmatter.get('compatibility', '')
|
||||
if compatibility:
|
||||
if not isinstance(compatibility, str):
|
||||
return False, f"Compatibility must be a string, got {type(compatibility).__name__}"
|
||||
if len(compatibility) > 500:
|
||||
return False, f"Compatibility is too long ({len(compatibility)} characters). Maximum is 500 characters."
|
||||
|
||||
return True, "Skill is valid!"
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) != 2:
|
||||
print("Usage: python quick_validate.py <skill_directory>")
|
||||
sys.exit(1)
|
||||
|
||||
valid, message = validate_skill(sys.argv[1])
|
||||
print(message)
|
||||
sys.exit(0 if valid else 1)
|
||||
@ -109,6 +109,7 @@ class MainTerminal:
|
||||
|
||||
# 初始化组件
|
||||
self.api_client = DeepSeekClient(thinking_mode=self.thinking_mode)
|
||||
self.api_client.project_path = project_path
|
||||
self.api_client.set_deep_thinking_mode(self.deep_thinking_mode)
|
||||
self.model_key = "kimi-k2.5"
|
||||
self.model_profile = get_model_profile(self.model_key)
|
||||
@ -128,8 +129,8 @@ class MainTerminal:
|
||||
self.search_engine = SearchEngine()
|
||||
self.terminal_ops = TerminalOperator(project_path, container_session=container_session)
|
||||
self.ocr_client = OCRClient(project_path, self.file_manager)
|
||||
self.pending_image_view = None # 供 view_image 工具使用，保存一次性图片插入请求
|
||||
self.pending_video_view = None # 供 view_video 工具使用，保存一次性视频插入请求
|
||||
self.pending_image_view = None # 供 view_image 工具使用，保存一次性图片附加请求
|
||||
self.pending_video_view = None # 供 view_video 工具使用，保存一次性视频附加请求
|
||||
|
||||
# 新增：终端管理器
|
||||
self.terminal_manager = TerminalManager(
|
||||
@ -826,6 +827,20 @@ class MainTerminal:
|
||||
except Exception:
|
||||
result_data = {}
|
||||
tool_result_content = format_tool_result_for_context(tool_name, result_data, result)
|
||||
tool_images = None
|
||||
tool_videos = None
|
||||
if (
|
||||
isinstance(result_data, dict)
|
||||
and result_data.get("success") is not False
|
||||
):
|
||||
if tool_name == "view_image":
|
||||
img_path = result_data.get("path")
|
||||
if img_path:
|
||||
tool_images = [img_path]
|
||||
elif tool_name == "view_video":
|
||||
video_path = result_data.get("path")
|
||||
if video_path:
|
||||
tool_videos = [video_path]
|
||||
|
||||
# 收集工具结果（不保存）
|
||||
collected_tool_results.append({
|
||||
@ -835,6 +850,8 @@ class MainTerminal:
|
||||
"system_message": result_data.get("system_message") if isinstance(result_data, dict) else None,
|
||||
"task_id": result_data.get("task_id") if isinstance(result_data, dict) else None,
|
||||
"raw_result_data": result_data if result_data else None,
|
||||
"images": tool_images,
|
||||
"videos": tool_videos,
|
||||
})
|
||||
|
||||
return result
|
||||
@ -872,7 +889,9 @@ class MainTerminal:
|
||||
"tool",
|
||||
tool_result["content"],
|
||||
tool_call_id=tool_result["tool_call_id"],
|
||||
name=tool_result["name"]
|
||||
name=tool_result["name"],
|
||||
images=tool_result.get("images"),
|
||||
videos=tool_result.get("videos")
|
||||
)
|
||||
system_message = tool_result.get("system_message")
|
||||
if system_message:
|
||||
@ -1544,7 +1563,7 @@ class MainTerminal:
|
||||
"type": "function",
|
||||
"function": {
|
||||
"name": "terminal_input",
|
||||
"description": "向活动终端发送命令或输入。禁止启动会占用终端界面的程序（python/node/nano/vim 等）；如遇卡死请结合 terminal_snapshot 并使用 terminal_reset 恢复。timeout 必填：\n1) 传入数字（秒，最大300）会对命令进行硬超时封装。系统终端执行环境若存在 timeout/gtimeout，会采用类似 timeout -k 2 {秒}s sh -c '命令; echo __CMD_DONE__...__' 的封装；若没有 timeout/gtimeout（少见情况），则退化为外层 sh -c 的 sleep/kill 包装，例如：sh -c '运行的指令 & CMD_PID=$!; (sleep 300 && kill -s INT $CMD_PID >/dev/null 2>&1 && sleep 2 && kill -s KILL $CMD_PID >/dev/null 2>&1) & WAITER=$!; wait $CMD_PID; CMD_STATUS=$?; kill $WAITER >/dev/null 2>&1; echo __CMD_DONE__1770826047975__; exit $CMD_STATUS'。超时后会先 INT 再 KILL，进程会被不可恢复地打断（可能留下半写文件、锁或残留子进程）。\n2) 传入 never 表示不封装、不杀进程，命令原样进入终端并维护状态；此时快照可能无法判断完成情况，需要用 curl/ps/ls 等主动验证。\n适合 timeout=never 的场景示例：启动常驻服务/开发服务器（npm run dev、python web_server.py、uvicorn ...）、开启后台进程后在另一个终端测试、在后台运行时间极长的任务同时做其他事情、持续输出/长时间任务（tail -f 日志、长时间编译/训练/备份/大下载）、需要维持会话状态的操作（例如登录远程服务器后连续执行多条命令）。适合用数字超时的示例：ls/rg/pytest/短脚本等快速命令。\n若不确定上一条命令是否结束，先用 terminal_snapshot 确认后再继续输入。",
|
||||
"description": "向活动终端发送命令或输入。禁止启动会占用终端界面的程序（python/node/nano/vim 等）；如遇卡死请结合 terminal_snapshot 并使用 terminal_reset 恢复。timeout 必填：\n1) 传入数字（秒，最大300）会对命令进行硬超时封装。系统终端执行环境若存在 timeout/gtimeout，会采用类似 timeout -k 2 {秒}s sh -c '命令; echo __CMD_DONE__...__' 的封装；若没有 timeout/gtimeout（少见情况），则退化为外层 sh -c 的 sleep/kill 包装，例如：sh -c '运行的指令 & CMD_PID=$!; (sleep 300 && kill -s INT $CMD_PID >/dev/null 2>&1 && sleep 2 && kill -s KILL $CMD_PID >/dev/null 2>&1) & WAITER=$!; wait $CMD_PID; CMD_STATUS=$?; kill $WAITER >/dev/null 2>&1; echo __CMD_DONE__1770826047975__; exit $CMD_STATUS'。超时后会先 INT 再 KILL，进程会被不可恢复地打断（可能留下半写文件、锁或残留子进程）。\n2) 传入 never 表示不封装、不杀进程，命令原样进入终端并维护状态，会在运行完成前持续占用终端窗口，在确认完成前无法发送新的指令；此时快照可能无法判断完成情况，需要在其他终端或用run_command使用 curl/ps/ls 等主动验证。\n适合 timeout=never 的场景示例：启动常驻服务/开发服务器（npm run dev、python web_server.py、uvicorn ...）、开启后台进程后在另一个终端测试、在后台运行时间极长的任务同时做其他事情、Github大项目克隆、大文件下载、持续输出/长时间任务（tail -f 日志、长时间编译/训练/备份/大下载）、需要维持会话状态的操作（例如登录远程服务器后连续执行多条命令）。适合用数字超时的示例：ls/rg/pytest/短脚本等快速命令。\n若不确定上一条命令是否结束，先用 terminal_snapshot 确认后再继续输入。",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": self._inject_intent({
|
||||
@ -1863,13 +1882,13 @@ class MainTerminal:
|
||||
"type": "function",
|
||||
"function": {
|
||||
"name": "view_image",
|
||||
"description": "将指定本地图片插入到对话中（系统代发一条包含图片的消息），便于模型主动查看图片内容。",
|
||||
"description": "将指定本地图片附加到工具结果中（tool 消息携带 image_url），便于模型主动查看图片内容。",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": self._inject_intent({
|
||||
"path": {
|
||||
"type": "string",
|
||||
"description": "项目内的图片相对路径（不要以 /workspace 开头），支持 png/jpg/webp/gif/bmp/svg。"
|
||||
"description": "项目内的图片相对路径（不要以 /workspace 开头）；宿主机模式可用绝对路径。支持 png/jpg/webp/gif/bmp/svg。"
|
||||
}
|
||||
}),
|
||||
"required": ["path"]
|
||||
@ -1880,14 +1899,14 @@ class MainTerminal:
|
||||
tools.append({
|
||||
"type": "function",
|
||||
"function": {
|
||||
"name": "view_video",
|
||||
"description": "将指定本地视频插入到对话中（系统代发一条包含视频的消息），便于模型查看视频内容。",
|
||||
"name": "view_video",
|
||||
"description": "将指定本地视频附加到工具结果中（tool 消息携带 video_url），便于模型查看视频内容。",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": self._inject_intent({
|
||||
"path": {
|
||||
"type": "string",
|
||||
"description": "项目内的视频相对路径（不要以 /workspace 开头），支持 mp4/mov/mkv/avi/webm。"
|
||||
"path": {
|
||||
"type": "string",
|
||||
"description": "项目内的视频相对路径（不要以 /workspace 开头）；宿主机模式可用绝对路径。支持 mp4/mov/mkv/avi/webm。"
|
||||
}
|
||||
}),
|
||||
"required": ["path"]
|
||||
@ -1972,13 +1991,21 @@ class MainTerminal:
|
||||
path = (arguments.get("path") or "").strip()
|
||||
if not path:
|
||||
return json.dumps({"success": False, "error": "path 不能为空"}, ensure_ascii=False)
|
||||
host_unrestricted = self._is_host_mode()
|
||||
if path.startswith("/workspace"):
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用不带/workspace的相对路径"}, ensure_ascii=False)
|
||||
abs_path = (Path(self.context_manager.project_path) / path).resolve()
|
||||
try:
|
||||
abs_path.relative_to(Path(self.context_manager.project_path).resolve())
|
||||
except Exception:
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用不带/workspace的相对路径"}, ensure_ascii=False)
|
||||
if host_unrestricted:
|
||||
path = path.split("/workspace", 1)[1].lstrip("/")
|
||||
else:
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用不带/workspace的相对路径"}, ensure_ascii=False)
|
||||
if host_unrestricted and (Path(path).is_absolute() or (len(path) > 1 and path[1] == ":")):
|
||||
abs_path = Path(path).expanduser().resolve()
|
||||
else:
|
||||
abs_path = (Path(self.context_manager.project_path) / path).resolve()
|
||||
if not host_unrestricted:
|
||||
try:
|
||||
abs_path.relative_to(Path(self.context_manager.project_path).resolve())
|
||||
except Exception:
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用不带/workspace的相对路径"}, ensure_ascii=False)
|
||||
if not abs_path.exists() or not abs_path.is_file():
|
||||
return json.dumps({"success": False, "error": f"图片不存在: {path}"}, ensure_ascii=False)
|
||||
if abs_path.stat().st_size > 10 * 1024 * 1024:
|
||||
@ -1986,22 +2013,30 @@ class MainTerminal:
|
||||
allowed_ext = {".png", ".jpg", ".jpeg", ".webp", ".gif", ".bmp", ".svg"}
|
||||
if abs_path.suffix.lower() not in allowed_ext:
|
||||
return json.dumps({"success": False, "error": f"不支持的图片格式: {abs_path.suffix}"}, ensure_ascii=False)
|
||||
# 记录待注入图片，供上层循环追加消息
|
||||
# 记录待附加图片，供上层将图片附加到工具结果
|
||||
self.pending_image_view = {
|
||||
"path": str(path)
|
||||
}
|
||||
result = {"success": True, "message": "图片已请求插入到对话中，将在后续消息中呈现。", "path": path}
|
||||
result = {"success": True, "message": "图片已附加到工具结果中，将随 tool 返回。", "path": path}
|
||||
elif tool_name == "view_video":
|
||||
path = (arguments.get("path") or "").strip()
|
||||
if not path:
|
||||
return json.dumps({"success": False, "error": "path 不能为空"}, ensure_ascii=False)
|
||||
host_unrestricted = self._is_host_mode()
|
||||
if path.startswith("/workspace"):
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用相对路径"}, ensure_ascii=False)
|
||||
abs_path = (Path(self.context_manager.project_path) / path).resolve()
|
||||
try:
|
||||
abs_path.relative_to(Path(self.context_manager.project_path).resolve())
|
||||
except Exception:
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用相对路径"}, ensure_ascii=False)
|
||||
if host_unrestricted:
|
||||
path = path.split("/workspace", 1)[1].lstrip("/")
|
||||
else:
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用相对路径"}, ensure_ascii=False)
|
||||
if host_unrestricted and (Path(path).is_absolute() or (len(path) > 1 and path[1] == ":")):
|
||||
abs_path = Path(path).expanduser().resolve()
|
||||
else:
|
||||
abs_path = (Path(self.context_manager.project_path) / path).resolve()
|
||||
if not host_unrestricted:
|
||||
try:
|
||||
abs_path.relative_to(Path(self.context_manager.project_path).resolve())
|
||||
except Exception:
|
||||
return json.dumps({"success": False, "error": "非法路径，超出项目根目录，请使用相对路径"}, ensure_ascii=False)
|
||||
if not abs_path.exists() or not abs_path.is_file():
|
||||
return json.dumps({"success": False, "error": f"视频不存在: {path}"}, ensure_ascii=False)
|
||||
allowed_ext = {".mp4", ".mov", ".mkv", ".avi", ".webm"}
|
||||
@ -2010,7 +2045,7 @@ class MainTerminal:
|
||||
if abs_path.stat().st_size > 50 * 1024 * 1024:
|
||||
return json.dumps({"success": False, "error": "视频过大，需 <= 50MB"}, ensure_ascii=False)
|
||||
self.pending_video_view = {"path": str(path)}
|
||||
result = {"success": True, "message": "视频已请求插入到对话中，将在后续消息中呈现。", "path": path}
|
||||
result = {"success": True, "message": "视频已附加到工具结果中，将随 tool 返回。", "path": path}
|
||||
|
||||
# 终端会话管理工具
|
||||
elif tool_name == "terminal_session":
|
||||
@ -2601,9 +2636,18 @@ class MainTerminal:
|
||||
|
||||
elif conv["role"] == "tool":
|
||||
# Tool消息需要保留完整结构
|
||||
images = conv.get("images") or metadata.get("images") or []
|
||||
videos = conv.get("videos") or metadata.get("videos") or []
|
||||
content_value = conv.get("content")
|
||||
if isinstance(content_value, list):
|
||||
content_payload = content_value
|
||||
elif images or videos:
|
||||
content_payload = self.context_manager._build_content_with_images(content_value, images, videos)
|
||||
else:
|
||||
content_payload = content_value
|
||||
message = {
|
||||
"role": "tool",
|
||||
"content": conv["content"],
|
||||
"content": content_payload,
|
||||
"tool_call_id": conv.get("tool_call_id", ""),
|
||||
"name": conv.get("name", "")
|
||||
}
|
||||
|
||||
@ -79,6 +79,11 @@ class FileManager:
|
||||
if self.container_session and getattr(self.container_session, "mode", None) is not None:
|
||||
return getattr(self.container_session, "mode", None) == "docker"
|
||||
return (TERMINAL_SANDBOX_MODE or "").lower() == "docker" or bool(LINUX_SAFETY)
|
||||
|
||||
def _is_host_mode(self) -> bool:
|
||||
if self.container_session and getattr(self.container_session, "mode", None) is not None:
|
||||
return getattr(self.container_session, "mode", None) != "docker"
|
||||
return (TERMINAL_SANDBOX_MODE or "").lower() == "host"
|
||||
|
||||
def _get_project_size(self) -> int:
|
||||
"""计算项目目录的总大小（字节），遇到异常时记录并抛出。"""
|
||||
@ -114,6 +119,20 @@ class FileManager:
|
||||
project_root = Path(self.project_path).resolve()
|
||||
if project_root != self.project_path:
|
||||
self.project_path = project_root
|
||||
|
||||
if self._is_host_mode():
|
||||
normalized = (path or "").strip()
|
||||
if normalized == "/workspace":
|
||||
normalized = ""
|
||||
elif normalized.startswith("/workspace/"):
|
||||
normalized = normalized.split("/workspace/", 1)[1]
|
||||
if not normalized:
|
||||
return True, "", project_root
|
||||
if Path(normalized).is_absolute() or (len(normalized) > 1 and normalized[1] == ":"):
|
||||
full_path = Path(normalized).expanduser().resolve()
|
||||
else:
|
||||
full_path = (project_root / normalized).resolve()
|
||||
return True, "", full_path
|
||||
|
||||
# 不允许绝对路径（除非是在项目内的绝对路径）
|
||||
if path.startswith('/') or path.startswith('\\') or (len(path) > 1 and path[1] == ':'):
|
||||
@ -155,7 +174,10 @@ class FileManager:
|
||||
return True, "", full_path
|
||||
|
||||
def _relative_path(self, full_path: Path) -> str:
|
||||
return str(full_path.relative_to(self.project_path))
|
||||
try:
|
||||
return str(full_path.relative_to(self.project_path))
|
||||
except ValueError:
|
||||
return str(full_path)
|
||||
|
||||
def create_file(self, path: str, content: str = "", file_type: str = "txt") -> Dict:
|
||||
"""创建文件"""
|
||||
@ -391,7 +413,7 @@ class FileManager:
|
||||
if not result["success"]:
|
||||
return result
|
||||
|
||||
relative_path = str(full_path.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(full_path)
|
||||
return {
|
||||
"success": True,
|
||||
"path": relative_path,
|
||||
@ -465,7 +487,7 @@ class FileManager:
|
||||
selected_lines = lines[start - 1 : end]
|
||||
content = "".join(selected_lines)
|
||||
|
||||
relative_path = str(full_path.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(full_path)
|
||||
return {
|
||||
"success": True,
|
||||
"path": relative_path,
|
||||
@ -534,7 +556,7 @@ class FileManager:
|
||||
"hits": [idx]
|
||||
})
|
||||
|
||||
relative_path = str(full_path.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(full_path)
|
||||
for window in matches:
|
||||
snippet_lines = lines[window["line_start"] - 1 : window["line_end"]]
|
||||
window["snippet"] = "".join(snippet_lines)
|
||||
@ -600,7 +622,7 @@ class FileManager:
|
||||
"content": snippet
|
||||
})
|
||||
|
||||
relative_path = str(full_path.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(full_path)
|
||||
return {
|
||||
"success": True,
|
||||
"path": relative_path,
|
||||
@ -1269,7 +1291,7 @@ class FileManager:
|
||||
with open(full_path, 'w', encoding='utf-8') as f:
|
||||
f.writelines(lines)
|
||||
|
||||
relative_path = str(full_path.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(full_path)
|
||||
|
||||
# 生成操作描述
|
||||
if operation == "replace":
|
||||
@ -1318,7 +1340,7 @@ class FileManager:
|
||||
if item.name.startswith('.'):
|
||||
continue
|
||||
|
||||
relative_path = str(item.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(item)
|
||||
|
||||
if item.is_file():
|
||||
files.append({
|
||||
@ -1335,7 +1357,7 @@ class FileManager:
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"path": str(full_path.relative_to(self.project_path)) if path else ".",
|
||||
"path": self._relative_path(full_path) if path else ".",
|
||||
"files": sorted(files, key=lambda x: x["name"]),
|
||||
"folders": sorted(folders, key=lambda x: x["name"])
|
||||
}
|
||||
@ -1353,7 +1375,7 @@ class FileManager:
|
||||
|
||||
try:
|
||||
stat = full_path.stat()
|
||||
relative_path = str(full_path.relative_to(self.project_path))
|
||||
relative_path = self._relative_path(full_path)
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
|
||||
@ -56,7 +56,7 @@
|
||||
|
||||
### 3.3 视觉理解（重点）
|
||||
|
||||
你**自带多模态能力**，用户可以直接发送图片；如需主动查看本地图片，可调用 `view_image` 指定路径，系统会代发一条包含图片的用户消息供你查看。
|
||||
你**自带多模态能力**，用户可以直接发送图片；如需主动查看本地图片/视频，可调用 `view_image`/`view_video` 指定路径，系统会在工具结果中附带媒体（tool 消息携带 image_url/video_url）供你查看。
|
||||
|
||||
当用户提出"这是什么""识别文字/表格/票据""找瑕疵/细节""读屏/按钮含义"等图片分析任务时，优先采用下面的方法，保证细节充分、结论可验证：
|
||||
|
||||
|
||||
@ -2372,6 +2372,8 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
|
||||
# ===== 增量保存：立即保存工具结果 =====
|
||||
metadata_payload = None
|
||||
tool_images = None
|
||||
tool_videos = None
|
||||
if isinstance(result_data, dict):
|
||||
# 特殊处理 web_search：保留可供前端渲染的精简结构，以便历史记录复现搜索结果
|
||||
if function_name == "web_search":
|
||||
@ -2384,6 +2386,56 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
metadata_payload = {"tool_payload": result_data}
|
||||
else:
|
||||
tool_result_content = tool_result
|
||||
tool_message_content = tool_result_content
|
||||
|
||||
# view_image: 将图片直接附加到 tool 结果中（不再插入 user 消息）
|
||||
if function_name == "view_image" and getattr(web_terminal, "pending_image_view", None):
|
||||
inj = web_terminal.pending_image_view
|
||||
web_terminal.pending_image_view = None
|
||||
if (
|
||||
not tool_failed
|
||||
and isinstance(result_data, dict)
|
||||
and result_data.get("success") is not False
|
||||
):
|
||||
img_path = inj.get("path") if isinstance(inj, dict) else None
|
||||
if img_path:
|
||||
text_part = tool_result_content if isinstance(tool_result_content, str) else ""
|
||||
tool_message_content = web_terminal.context_manager._build_content_with_images(
|
||||
text_part,
|
||||
[img_path]
|
||||
)
|
||||
tool_images = [img_path]
|
||||
if metadata_payload is None:
|
||||
metadata_payload = {}
|
||||
metadata_payload["tool_image_path"] = img_path
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求将图片附加到工具结果: {img_path}'
|
||||
})
|
||||
|
||||
# view_video: 将视频直接附加到 tool 结果中（不再插入 user 消息）
|
||||
if function_name == "view_video" and getattr(web_terminal, "pending_video_view", None):
|
||||
inj = web_terminal.pending_video_view
|
||||
web_terminal.pending_video_view = None
|
||||
if (
|
||||
not tool_failed
|
||||
and isinstance(result_data, dict)
|
||||
and result_data.get("success") is not False
|
||||
):
|
||||
video_path = inj.get("path") if isinstance(inj, dict) else None
|
||||
if video_path:
|
||||
text_part = tool_result_content if isinstance(tool_result_content, str) else ""
|
||||
tool_message_content = web_terminal.context_manager._build_content_with_images(
|
||||
text_part,
|
||||
[],
|
||||
[video_path]
|
||||
)
|
||||
tool_videos = [video_path]
|
||||
if metadata_payload is None:
|
||||
metadata_payload = {}
|
||||
metadata_payload["tool_video_path"] = video_path
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求将视频附加到工具结果: {video_path}'
|
||||
})
|
||||
|
||||
# 立即保存工具结果
|
||||
web_terminal.context_manager.add_conversation(
|
||||
@ -2391,7 +2443,9 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
tool_result_content,
|
||||
tool_call_id=tool_call_id,
|
||||
name=function_name,
|
||||
metadata=metadata_payload
|
||||
metadata=metadata_payload,
|
||||
images=tool_images,
|
||||
videos=tool_videos
|
||||
)
|
||||
debug_log(f"💾 增量保存：工具结果 {function_name}")
|
||||
system_message = result_data.get("system_message") if isinstance(result_data, dict) else None
|
||||
@ -2404,21 +2458,9 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
"role": "tool",
|
||||
"tool_call_id": tool_call_id,
|
||||
"name": function_name,
|
||||
"content": tool_result_content
|
||||
"content": tool_message_content
|
||||
})
|
||||
|
||||
# 收集图片注入请求，延后统一追加
|
||||
if (
|
||||
function_name == "view_image"
|
||||
and getattr(web_terminal, "pending_image_view", None)
|
||||
and not tool_failed
|
||||
and (isinstance(result_data, dict) and result_data.get("success") is not False)
|
||||
):
|
||||
inj = web_terminal.pending_image_view
|
||||
web_terminal.pending_image_view = None
|
||||
if inj and inj.get("path"):
|
||||
image_injections.append(inj["path"])
|
||||
|
||||
if function_name not in {'write_file', 'edit_file'}:
|
||||
await process_sub_agent_updates(messages, inline=True, after_tool_call_id=tool_call_id)
|
||||
|
||||
@ -2430,29 +2472,6 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
# 标记不再是第一次迭代
|
||||
is_first_iteration = False
|
||||
|
||||
# 统一附加图片消息，保证所有 tool 响应先完成
|
||||
if image_injections:
|
||||
for img_path in image_injections:
|
||||
injected_text = "这是一条系统控制发送的信息，并非用户主动发送，目的是返回你需要查看的图片。"
|
||||
web_terminal.context_manager.add_conversation(
|
||||
"user",
|
||||
injected_text,
|
||||
images=[img_path],
|
||||
metadata={"system_injected_image": True}
|
||||
)
|
||||
content_payload = web_terminal.context_manager._build_content_with_images(
|
||||
injected_text,
|
||||
[img_path]
|
||||
)
|
||||
messages.append({
|
||||
"role": "user",
|
||||
"content": content_payload,
|
||||
"metadata": {"system_injected_image": True}
|
||||
})
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求插入图片: {img_path}'
|
||||
})
|
||||
|
||||
# 最终统计
|
||||
debug_log(f"\n{'='*40}")
|
||||
debug_log(f"任务完成统计:")
|
||||
|
||||
@ -1216,7 +1216,6 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
|
||||
full_response = ""
|
||||
tool_calls = []
|
||||
video_injections = []
|
||||
current_thinking = ""
|
||||
detected_tools = {}
|
||||
last_usage_payload = None
|
||||
@ -1993,8 +1992,6 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
last_tool_name = tool_name
|
||||
# 更新统计
|
||||
total_tool_calls += len(tool_calls)
|
||||
|
||||
image_injections: list[str] = []
|
||||
|
||||
# 执行每个工具
|
||||
for tool_call in tool_calls:
|
||||
@ -2286,6 +2283,8 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
|
||||
# ===== 增量保存：立即保存工具结果 =====
|
||||
metadata_payload = None
|
||||
tool_images = None
|
||||
tool_videos = None
|
||||
if isinstance(result_data, dict):
|
||||
# 特殊处理 web_search：保留可供前端渲染的精简结构，以便历史记录复现搜索结果
|
||||
if function_name == "web_search":
|
||||
@ -2298,6 +2297,56 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
metadata_payload = {"tool_payload": result_data}
|
||||
else:
|
||||
tool_result_content = tool_result
|
||||
tool_message_content = tool_result_content
|
||||
|
||||
# view_image: 将图片直接附加到 tool 结果中（不再插入 user 消息）
|
||||
if function_name == "view_image" and getattr(web_terminal, "pending_image_view", None):
|
||||
inj = web_terminal.pending_image_view
|
||||
web_terminal.pending_image_view = None
|
||||
if (
|
||||
not tool_failed
|
||||
and isinstance(result_data, dict)
|
||||
and result_data.get("success") is not False
|
||||
):
|
||||
img_path = inj.get("path") if isinstance(inj, dict) else None
|
||||
if img_path:
|
||||
text_part = tool_result_content if isinstance(tool_result_content, str) else ""
|
||||
tool_message_content = web_terminal.context_manager._build_content_with_images(
|
||||
text_part,
|
||||
[img_path]
|
||||
)
|
||||
tool_images = [img_path]
|
||||
if metadata_payload is None:
|
||||
metadata_payload = {}
|
||||
metadata_payload["tool_image_path"] = img_path
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求将图片附加到工具结果: {img_path}'
|
||||
})
|
||||
|
||||
# view_video: 将视频直接附加到 tool 结果中（不再插入 user 消息）
|
||||
if function_name == "view_video" and getattr(web_terminal, "pending_video_view", None):
|
||||
inj = web_terminal.pending_video_view
|
||||
web_terminal.pending_video_view = None
|
||||
if (
|
||||
not tool_failed
|
||||
and isinstance(result_data, dict)
|
||||
and result_data.get("success") is not False
|
||||
):
|
||||
video_path = inj.get("path") if isinstance(inj, dict) else None
|
||||
if video_path:
|
||||
text_part = tool_result_content if isinstance(tool_result_content, str) else ""
|
||||
tool_message_content = web_terminal.context_manager._build_content_with_images(
|
||||
text_part,
|
||||
[],
|
||||
[video_path]
|
||||
)
|
||||
tool_videos = [video_path]
|
||||
if metadata_payload is None:
|
||||
metadata_payload = {}
|
||||
metadata_payload["tool_video_path"] = video_path
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求将视频附加到工具结果: {video_path}'
|
||||
})
|
||||
|
||||
# 立即保存工具结果
|
||||
web_terminal.context_manager.add_conversation(
|
||||
@ -2305,7 +2354,9 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
tool_result_content,
|
||||
tool_call_id=tool_call_id,
|
||||
name=function_name,
|
||||
metadata=metadata_payload
|
||||
metadata=metadata_payload,
|
||||
images=tool_images,
|
||||
videos=tool_videos
|
||||
)
|
||||
debug_log(f"💾 增量保存：工具结果 {function_name}")
|
||||
system_message = result_data.get("system_message") if isinstance(result_data, dict) else None
|
||||
@ -2318,32 +2369,9 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
"role": "tool",
|
||||
"tool_call_id": tool_call_id,
|
||||
"name": function_name,
|
||||
"content": tool_result_content
|
||||
"content": tool_message_content
|
||||
})
|
||||
|
||||
# 收集图片/视频注入请求，延后统一追加
|
||||
if (
|
||||
function_name == "view_image"
|
||||
and getattr(web_terminal, "pending_image_view", None)
|
||||
and not tool_failed
|
||||
and (isinstance(result_data, dict) and result_data.get("success") is not False)
|
||||
):
|
||||
inj = web_terminal.pending_image_view
|
||||
web_terminal.pending_image_view = None
|
||||
if inj and inj.get("path"):
|
||||
image_injections.append(inj["path"])
|
||||
|
||||
if (
|
||||
function_name == "view_video"
|
||||
and getattr(web_terminal, "pending_video_view", None)
|
||||
and not tool_failed
|
||||
and (isinstance(result_data, dict) and result_data.get("success") is not False)
|
||||
):
|
||||
inj = web_terminal.pending_video_view
|
||||
web_terminal.pending_video_view = None
|
||||
if inj and inj.get("path"):
|
||||
video_injections.append(inj["path"])
|
||||
|
||||
if function_name not in {'write_file', 'edit_file'}:
|
||||
await process_sub_agent_updates(messages, inline=True, after_tool_call_id=tool_call_id)
|
||||
|
||||
@ -2355,51 +2383,6 @@ async def handle_task_with_sender(terminal: WebTerminal, workspace: UserWorkspac
|
||||
# 标记不再是第一次迭代
|
||||
is_first_iteration = False
|
||||
|
||||
# 统一附加图片/视频消息，保证所有 tool 响应先完成
|
||||
if image_injections:
|
||||
for img_path in image_injections:
|
||||
injected_text = "这是一条系统控制发送的信息，并非用户主动发送，目的是返回你需要查看的图片。"
|
||||
web_terminal.context_manager.add_conversation(
|
||||
"user",
|
||||
injected_text,
|
||||
images=[img_path],
|
||||
metadata={"system_injected_image": True}
|
||||
)
|
||||
content_payload = web_terminal.context_manager._build_content_with_images(
|
||||
injected_text,
|
||||
[img_path]
|
||||
)
|
||||
messages.append({
|
||||
"role": "user",
|
||||
"content": content_payload,
|
||||
"metadata": {"system_injected_image": True}
|
||||
})
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求插入图片: {img_path}'
|
||||
})
|
||||
|
||||
if video_injections:
|
||||
for video_path in video_injections:
|
||||
injected_text = "这是一条系统控制发送的信息，并非用户主动发送，目的是返回你需要查看的视频。"
|
||||
web_terminal.context_manager.add_conversation(
|
||||
"user",
|
||||
injected_text,
|
||||
videos=[video_path],
|
||||
metadata={"system_injected_video": True}
|
||||
)
|
||||
content_payload = web_terminal.context_manager._build_content_with_images(
|
||||
injected_text,
|
||||
[],
|
||||
[video_path]
|
||||
)
|
||||
messages.append({
|
||||
"role": "user",
|
||||
"content": content_payload,
|
||||
"metadata": {"system_injected_video": True}
|
||||
})
|
||||
sender('system_message', {
|
||||
'content': f'系统已按模型请求插入视频: {video_path}'
|
||||
})
|
||||
|
||||
# 最终统计
|
||||
debug_log(f"\n{'='*40}")
|
||||
|
||||
@ -46,7 +46,9 @@
|
||||
:display-mode-disabled="displayModeSwitchDisabled"
|
||||
@toggle="toggleSidebar"
|
||||
@create="createNewConversation"
|
||||
@search="handleSidebarSearch"
|
||||
@search="handleSidebarSearchInput"
|
||||
@search-submit="handleSidebarSearchSubmit"
|
||||
@search-more="loadMoreSearchResults"
|
||||
@select="loadConversation"
|
||||
@load-more="loadMoreConversations"
|
||||
@personal="openPersonalPage"
|
||||
@ -413,7 +415,9 @@
|
||||
collapse-button-variant="close"
|
||||
@toggle="closeMobileOverlay"
|
||||
@create="createNewConversation"
|
||||
@search="handleSidebarSearch"
|
||||
@search="handleSidebarSearchInput"
|
||||
@search-submit="handleSidebarSearchSubmit"
|
||||
@search-more="loadMoreSearchResults"
|
||||
@select="handleMobileOverlaySelect($event)"
|
||||
@load-more="loadMoreConversations"
|
||||
@personal="openPersonalPage"
|
||||
|
||||
@ -225,6 +225,10 @@ const traceLog = (...args) => {
|
||||
}
|
||||
};
|
||||
|
||||
const SEARCH_INITIAL_BATCH = 100;
|
||||
const SEARCH_MORE_BATCH = 50;
|
||||
const SEARCH_PREVIEW_LIMIT = 20;
|
||||
|
||||
const appOptions = {
|
||||
data() {
|
||||
return {
|
||||
@ -248,6 +252,11 @@ const appOptions = {
|
||||
|
||||
// 搜索功能
|
||||
// ==========================================
|
||||
searchRequestSeq: 0,
|
||||
searchActiveQuery: '',
|
||||
searchResultIdSet: new Set(),
|
||||
searchPreviewCache: {},
|
||||
|
||||
// Token统计相关状态（修复版）
|
||||
// ==========================================
|
||||
|
||||
@ -409,6 +418,12 @@ const appOptions = {
|
||||
'currentConversationTitle',
|
||||
'searchQuery',
|
||||
'searchTimer',
|
||||
'searchResults',
|
||||
'searchActive',
|
||||
'searchInProgress',
|
||||
'searchMoreAvailable',
|
||||
'searchOffset',
|
||||
'searchTotal',
|
||||
'conversationsOffset',
|
||||
'conversationsLimit'
|
||||
]),
|
||||
@ -2324,28 +2339,168 @@ const appOptions = {
|
||||
}
|
||||
},
|
||||
|
||||
searchConversations() {
|
||||
// 简单的搜索功能，实际实现可以调用搜索API
|
||||
if (this.searchTimer) {
|
||||
clearTimeout(this.searchTimer);
|
||||
}
|
||||
|
||||
this.searchTimer = setTimeout(() => {
|
||||
if (this.searchQuery.trim()) {
|
||||
debugLog('搜索对话:', this.searchQuery);
|
||||
// TODO: 实现搜索API调用
|
||||
// this.searchConversationsAPI(this.searchQuery);
|
||||
} else {
|
||||
// 清空搜索，重新加载全部对话
|
||||
this.conversationsOffset = 0;
|
||||
this.loadConversationsList();
|
||||
}
|
||||
}, 300);
|
||||
handleSidebarSearchInput(value) {
|
||||
this.searchQuery = value;
|
||||
},
|
||||
|
||||
handleSidebarSearch(value) {
|
||||
handleSidebarSearchSubmit(value) {
|
||||
this.searchQuery = value;
|
||||
this.searchConversations();
|
||||
const trimmed = String(value || '').trim();
|
||||
if (!trimmed) {
|
||||
this.exitConversationSearch();
|
||||
return;
|
||||
}
|
||||
this.startConversationSearch(trimmed);
|
||||
},
|
||||
|
||||
exitConversationSearch() {
|
||||
this.searchActive = false;
|
||||
this.searchInProgress = false;
|
||||
this.searchMoreAvailable = false;
|
||||
this.searchOffset = 0;
|
||||
this.searchTotal = 0;
|
||||
this.searchResults = [];
|
||||
this.searchActiveQuery = '';
|
||||
this.searchResultIdSet = new Set();
|
||||
this.conversationsOffset = 0;
|
||||
this.loadConversationsList();
|
||||
},
|
||||
|
||||
async startConversationSearch(query) {
|
||||
const trimmed = String(query || '').trim();
|
||||
if (!trimmed) {
|
||||
return;
|
||||
}
|
||||
const requestSeq = ++this.searchRequestSeq;
|
||||
this.searchActiveQuery = trimmed;
|
||||
this.searchActive = true;
|
||||
this.searchInProgress = true;
|
||||
this.searchMoreAvailable = false;
|
||||
this.searchOffset = 0;
|
||||
this.searchTotal = 0;
|
||||
this.searchResults = [];
|
||||
this.searchResultIdSet = new Set();
|
||||
await this.searchNextConversationBatch(SEARCH_INITIAL_BATCH, requestSeq);
|
||||
},
|
||||
|
||||
async loadMoreSearchResults() {
|
||||
if (!this.searchActive || this.searchInProgress || !this.searchMoreAvailable) {
|
||||
return;
|
||||
}
|
||||
const requestSeq = this.searchRequestSeq;
|
||||
this.searchInProgress = true;
|
||||
await this.searchNextConversationBatch(SEARCH_MORE_BATCH, requestSeq);
|
||||
},
|
||||
|
||||
async searchNextConversationBatch(batchSize, requestSeq) {
|
||||
const query = this.searchActiveQuery;
|
||||
if (!query) {
|
||||
if (requestSeq === this.searchRequestSeq) {
|
||||
this.searchInProgress = false;
|
||||
}
|
||||
return;
|
||||
}
|
||||
try {
|
||||
const response = await fetch(`/api/conversations?limit=${batchSize}&offset=${this.searchOffset}`);
|
||||
const payload = await response.json();
|
||||
|
||||
if (requestSeq !== this.searchRequestSeq) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!payload.success) {
|
||||
console.error('搜索对话失败:', payload.error || payload.message);
|
||||
this.searchInProgress = false;
|
||||
return;
|
||||
}
|
||||
|
||||
const data = payload.data || {};
|
||||
const conversations = data.conversations || [];
|
||||
if (!this.searchTotal) {
|
||||
this.searchTotal = data.total || 0;
|
||||
}
|
||||
|
||||
for (const conv of conversations) {
|
||||
if (requestSeq !== this.searchRequestSeq) {
|
||||
return;
|
||||
}
|
||||
await this.matchConversation(conv, query, requestSeq);
|
||||
}
|
||||
|
||||
this.searchOffset += conversations.length;
|
||||
this.searchMoreAvailable = this.searchOffset < (this.searchTotal || 0);
|
||||
} catch (error) {
|
||||
console.error('搜索对话异常:', error);
|
||||
} finally {
|
||||
if (requestSeq === this.searchRequestSeq) {
|
||||
this.searchInProgress = false;
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
async matchConversation(conversation, query, requestSeq) {
|
||||
if (!conversation || !conversation.id) {
|
||||
return;
|
||||
}
|
||||
if (this.searchResultIdSet && this.searchResultIdSet.has(conversation.id)) {
|
||||
return;
|
||||
}
|
||||
const firstSentence = await this.getConversationFirstUserSentence(conversation.id, requestSeq);
|
||||
if (requestSeq !== this.searchRequestSeq) {
|
||||
return;
|
||||
}
|
||||
const queryLower = String(query || '').toLowerCase();
|
||||
const combined = `${conversation.title || ''} ${firstSentence || ''}`.toLowerCase();
|
||||
if (queryLower && combined.includes(queryLower)) {
|
||||
this.searchResults.push(conversation);
|
||||
this.searchResultIdSet.add(conversation.id);
|
||||
}
|
||||
},
|
||||
|
||||
async getConversationFirstUserSentence(conversationId, requestSeq) {
|
||||
if (!conversationId) {
|
||||
return '';
|
||||
}
|
||||
if (this.searchPreviewCache && Object.prototype.hasOwnProperty.call(this.searchPreviewCache, conversationId)) {
|
||||
return this.searchPreviewCache[conversationId];
|
||||
}
|
||||
try {
|
||||
const resp = await fetch(`/api/conversations/${conversationId}/review_preview?limit=${SEARCH_PREVIEW_LIMIT}`);
|
||||
const payload = await resp.json();
|
||||
if (requestSeq !== this.searchRequestSeq) {
|
||||
return '';
|
||||
}
|
||||
const lines = payload?.data?.preview || [];
|
||||
let firstUserLine = '';
|
||||
for (const line of lines) {
|
||||
if (typeof line === 'string' && line.startsWith('user：')) {
|
||||
firstUserLine = line.slice('user：'.length).trim();
|
||||
break;
|
||||
}
|
||||
}
|
||||
const firstSentence = this.extractFirstSentence(firstUserLine);
|
||||
const cached = firstSentence || firstUserLine || '';
|
||||
if (!this.searchPreviewCache) {
|
||||
this.searchPreviewCache = {};
|
||||
}
|
||||
this.searchPreviewCache[conversationId] = cached;
|
||||
return cached;
|
||||
} catch (error) {
|
||||
console.error('获取对话预览失败:', error);
|
||||
return '';
|
||||
}
|
||||
},
|
||||
|
||||
extractFirstSentence(text) {
|
||||
if (!text) {
|
||||
return '';
|
||||
}
|
||||
const normalized = String(text).replace(/\s+/g, ' ').trim();
|
||||
const match = normalized.match(/(.+?[。！？.!?])/);
|
||||
if (match) {
|
||||
return match[1];
|
||||
}
|
||||
return normalized;
|
||||
},
|
||||
|
||||
handleMobileOverlaySelect(conversationId) {
|
||||
|
||||
@ -129,20 +129,25 @@
|
||||
|
||||
<template v-if="!collapsed">
|
||||
<div class="conversation-search">
|
||||
<input
|
||||
class="search-input"
|
||||
:value="searchQuery"
|
||||
placeholder="搜索对话..."
|
||||
@input="$emit('search', ($event.target as HTMLInputElement).value)"
|
||||
/>
|
||||
<div class="search-input-wrap">
|
||||
<input
|
||||
class="search-input"
|
||||
:value="searchQuery"
|
||||
placeholder="搜索对话..."
|
||||
@input="$emit('search', ($event.target as HTMLInputElement).value)"
|
||||
@keydown.enter.prevent="$emit('search-submit', ($event.target as HTMLInputElement).value)"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="conversation-list">
|
||||
<div v-if="loading" class="loading-conversations">正在加载...</div>
|
||||
<div v-else-if="!conversations.length" class="no-conversations">暂无对话记录</div>
|
||||
<div v-if="loading && !displayConversations.length && !searchActive" class="loading-conversations">正在加载...</div>
|
||||
<div v-else-if="!displayConversations.length && !loading" class="no-conversations">
|
||||
{{ searchActive ? '未找到匹配对话' : '暂无对话记录' }}
|
||||
</div>
|
||||
<div v-else>
|
||||
<div
|
||||
v-for="conv in conversations"
|
||||
v-for="conv in displayConversations"
|
||||
:key="conv.id"
|
||||
class="conversation-item"
|
||||
:class="{ active: conv.id === currentConversationId }"
|
||||
@ -176,11 +181,30 @@
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div v-if="hasMore" class="load-more">
|
||||
<div v-if="!searchActive && hasMore" class="load-more">
|
||||
<button class="load-more-btn" type="button" :disabled="loadingMore" @click="$emit('load-more')">
|
||||
{{ loadingMore ? '载入中...' : '加载更多' }}
|
||||
</button>
|
||||
</div>
|
||||
<div v-else-if="searchActive" class="load-more search-more">
|
||||
<div v-if="searchInProgress" class="search-progress">
|
||||
<span class="search-spinner" aria-hidden="true">
|
||||
<span class="search-spinner-orbit">
|
||||
<span class="icon icon-sm search-spinner-icon" :style="iconStyle('search')"></span>
|
||||
</span>
|
||||
</span>
|
||||
<span class="search-progress-text">搜索中...</span>
|
||||
</div>
|
||||
<button
|
||||
v-else-if="searchMoreAvailable"
|
||||
class="load-more-btn"
|
||||
type="button"
|
||||
@click="$emit('search-more')"
|
||||
>
|
||||
搜索更多
|
||||
</button>
|
||||
<div v-else-if="displayConversations.length" class="search-done">已全部搜索</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
<template v-else>
|
||||
@ -239,8 +263,10 @@ defineEmits<{
|
||||
(event: 'toggle'): void;
|
||||
(event: 'create'): void;
|
||||
(event: 'search', value: string): void;
|
||||
(event: 'search-submit', value: string): void;
|
||||
(event: 'select', id: string): void;
|
||||
(event: 'load-more'): void;
|
||||
(event: 'search-more'): void;
|
||||
(event: 'personal'): void;
|
||||
(event: 'delete', id: string): void;
|
||||
(event: 'duplicate', id: string): void;
|
||||
@ -254,8 +280,12 @@ const personalizationStore = usePersonalizationStore();
|
||||
const { sidebarCollapsed: collapsed, workspaceCollapsed, chatDisplayMode: uiChatDisplayMode } = storeToRefs(uiStore);
|
||||
const {
|
||||
searchQuery,
|
||||
searchResults,
|
||||
searchActive,
|
||||
searchInProgress,
|
||||
searchMoreAvailable,
|
||||
conversations,
|
||||
conversationsLoading: loading,
|
||||
conversationsLoading,
|
||||
hasMoreConversations: hasMore,
|
||||
loadingMoreConversations: loadingMore,
|
||||
currentConversationId
|
||||
@ -269,5 +299,7 @@ const resolvedCollapseButtonVariant = computed(() => props.collapseButtonVariant
|
||||
const displayMode = computed(() => props.displayMode);
|
||||
const monitorModeActive = computed(() => displayMode.value === 'monitor' || uiChatDisplayMode.value === 'monitor');
|
||||
const displayModeDisabled = computed(() => props.displayModeDisabled);
|
||||
const displayConversations = computed(() => (searchActive.value ? searchResults.value : conversations.value));
|
||||
const loading = computed(() => (searchActive.value ? searchInProgress.value : conversationsLoading.value));
|
||||
|
||||
</script>
|
||||
|
||||
@ -10,6 +10,7 @@ export interface ConversationSummary {
|
||||
|
||||
interface ConversationState {
|
||||
conversations: ConversationSummary[];
|
||||
searchResults: ConversationSummary[];
|
||||
conversationsLoading: boolean;
|
||||
hasMoreConversations: boolean;
|
||||
loadingMoreConversations: boolean;
|
||||
@ -17,6 +18,11 @@ interface ConversationState {
|
||||
currentConversationTitle: string;
|
||||
searchQuery: string;
|
||||
searchTimer: ReturnType<typeof setTimeout> | null;
|
||||
searchActive: boolean;
|
||||
searchInProgress: boolean;
|
||||
searchMoreAvailable: boolean;
|
||||
searchOffset: number;
|
||||
searchTotal: number;
|
||||
conversationsOffset: number;
|
||||
conversationsLimit: number;
|
||||
}
|
||||
@ -24,6 +30,7 @@ interface ConversationState {
|
||||
export const useConversationStore = defineStore('conversation', {
|
||||
state: (): ConversationState => ({
|
||||
conversations: [],
|
||||
searchResults: [],
|
||||
conversationsLoading: false,
|
||||
hasMoreConversations: false,
|
||||
loadingMoreConversations: false,
|
||||
@ -31,12 +38,23 @@ export const useConversationStore = defineStore('conversation', {
|
||||
currentConversationTitle: '',
|
||||
searchQuery: '',
|
||||
searchTimer: null,
|
||||
searchActive: false,
|
||||
searchInProgress: false,
|
||||
searchMoreAvailable: false,
|
||||
searchOffset: 0,
|
||||
searchTotal: 0,
|
||||
conversationsOffset: 0,
|
||||
conversationsLimit: 20
|
||||
}),
|
||||
actions: {
|
||||
resetConversations() {
|
||||
this.conversations = [];
|
||||
this.searchResults = [];
|
||||
this.searchActive = false;
|
||||
this.searchInProgress = false;
|
||||
this.searchMoreAvailable = false;
|
||||
this.searchOffset = 0;
|
||||
this.searchTotal = 0;
|
||||
this.hasMoreConversations = false;
|
||||
this.loadingMoreConversations = false;
|
||||
this.conversationsOffset = 0;
|
||||
|
||||
@ -499,6 +499,11 @@
|
||||
border-bottom: 1px solid var(--claude-border);
|
||||
}
|
||||
|
||||
.search-input-wrap {
|
||||
position: relative;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.search-input {
|
||||
width: 100%;
|
||||
padding: 8px 12px;
|
||||
@ -532,6 +537,66 @@ o-conversations {
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.no-conversations {
|
||||
text-align: center;
|
||||
color: var(--claude-text-secondary);
|
||||
padding: 30px 15px;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.search-more {
|
||||
padding: 8px 12px 16px;
|
||||
}
|
||||
|
||||
.search-progress {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
gap: 8px;
|
||||
color: var(--claude-text-secondary);
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
.search-spinner {
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
display: inline-flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.search-spinner-orbit {
|
||||
position: absolute;
|
||||
inset: 0;
|
||||
}
|
||||
|
||||
.search-spinner-icon {
|
||||
position: absolute;
|
||||
top: 50%;
|
||||
left: 50%;
|
||||
transform: translate(-50%, -50%);
|
||||
animation: search-wobble 0.9s ease-in-out infinite;
|
||||
}
|
||||
|
||||
.search-done {
|
||||
text-align: center;
|
||||
color: var(--claude-text-secondary);
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
@keyframes search-wobble {
|
||||
from {
|
||||
transform: translate(-50%, -50%) translateX(-1px);
|
||||
}
|
||||
50% {
|
||||
transform: translate(-50%, -50%) translateX(1px);
|
||||
}
|
||||
to {
|
||||
transform: translate(-50%, -50%) translateX(-1px);
|
||||
}
|
||||
}
|
||||
|
||||
.conversation-item {
|
||||
padding: 12px 16px;
|
||||
margin: 2px 8px;
|
||||
|
||||
@ -4,6 +4,8 @@
|
||||
import httpx
|
||||
import json
|
||||
import asyncio
|
||||
import base64
|
||||
import mimetypes
|
||||
from typing import List, Dict, Optional, AsyncGenerator, Any
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
@ -64,6 +66,7 @@ class DeepSeekClient:
|
||||
self.api_key = self.fast_api_config["api_key"]
|
||||
self.model_id = self.fast_api_config["model_id"]
|
||||
self.model_key = None # 由宿主终端注入，便于做模型兼容处理
|
||||
self.project_path: Optional[str] = None
|
||||
# 每个任务的独立状态
|
||||
self.current_task_first_call = True # 当前任务是否是第一次调用
|
||||
self.current_task_thinking = "" # 当前任务的思考内容
|
||||
@ -124,6 +127,43 @@ class DeepSeekClient:
|
||||
if not match_texts:
|
||||
match_texts.append("未找到匹配内容。")
|
||||
return "\n".join([header] + match_texts)
|
||||
|
||||
def _build_content_with_images(self, text: str, images: List[str], videos: Optional[List[str]] = None) -> Any:
|
||||
"""将文本与图片/视频路径拼成多模态 content（用于 tool 消息）。"""
|
||||
videos = videos or []
|
||||
if not images and not videos:
|
||||
return text
|
||||
parts: List[Dict[str, Any]] = []
|
||||
if text:
|
||||
parts.append({"type": "text", "text": text})
|
||||
base_path = Path(self.project_path or ".")
|
||||
for path in images:
|
||||
try:
|
||||
abs_path = (base_path / path).resolve()
|
||||
if not abs_path.exists() or not abs_path.is_file():
|
||||
continue
|
||||
mime, _ = mimetypes.guess_type(abs_path.name)
|
||||
if not mime:
|
||||
mime = "image/png"
|
||||
data = abs_path.read_bytes()
|
||||
b64 = base64.b64encode(data).decode("utf-8")
|
||||
parts.append({"type": "image_url", "image_url": {"url": f"data:{mime};base64,{b64}"}})
|
||||
except Exception:
|
||||
continue
|
||||
for path in videos:
|
||||
try:
|
||||
abs_path = (base_path / path).resolve()
|
||||
if not abs_path.exists() or not abs_path.is_file():
|
||||
continue
|
||||
mime, _ = mimetypes.guess_type(abs_path.name)
|
||||
if not mime:
|
||||
mime = "video/mp4"
|
||||
data = abs_path.read_bytes()
|
||||
b64 = base64.b64encode(data).decode("utf-8")
|
||||
parts.append({"type": "video_url", "video_url": {"url": f"data:{mime};base64,{b64}"}})
|
||||
except Exception:
|
||||
continue
|
||||
return parts if parts else text
|
||||
|
||||
if read_type == "extract":
|
||||
segments = data.get("segments", [])
|
||||
@ -770,20 +810,37 @@ class DeepSeekClient:
|
||||
tool_result = await tool_handler(function_name, arguments)
|
||||
|
||||
# 解析工具结果，提取关键信息
|
||||
result_data = None
|
||||
try:
|
||||
result_data = json.loads(tool_result)
|
||||
if function_name == "read_file":
|
||||
tool_result_msg = self._format_read_file_result(result_data)
|
||||
else:
|
||||
tool_result_msg = tool_result
|
||||
except:
|
||||
except Exception:
|
||||
tool_result_msg = tool_result
|
||||
|
||||
tool_message_content = tool_result_msg
|
||||
if (
|
||||
isinstance(result_data, dict)
|
||||
and result_data.get("success") is not False
|
||||
):
|
||||
if function_name == "view_image":
|
||||
img_path = result_data.get("path")
|
||||
if img_path:
|
||||
text_part = tool_result_msg if isinstance(tool_result_msg, str) else ""
|
||||
tool_message_content = self._build_content_with_images(text_part, [img_path])
|
||||
elif function_name == "view_video":
|
||||
video_path = result_data.get("path")
|
||||
if video_path:
|
||||
text_part = tool_result_msg if isinstance(tool_result_msg, str) else ""
|
||||
tool_message_content = self._build_content_with_images(text_part, [], [video_path])
|
||||
|
||||
messages.append({
|
||||
"role": "tool",
|
||||
"tool_call_id": tool_call["id"],
|
||||
"name": function_name,
|
||||
"content": tool_result_msg
|
||||
"content": tool_message_content
|
||||
})
|
||||
|
||||
# 记录工具结果
|
||||
|
||||
@ -1569,9 +1569,18 @@ class ContextManager:
|
||||
message["tool_calls"] = conv["tool_calls"]
|
||||
messages.append(message)
|
||||
elif conv["role"] == "tool":
|
||||
images = conv.get("images") or (conv.get("metadata") or {}).get("images") or []
|
||||
videos = conv.get("videos") or (conv.get("metadata") or {}).get("videos") or []
|
||||
content_value = conv.get("content")
|
||||
if isinstance(content_value, list):
|
||||
content_payload = content_value
|
||||
elif images or videos:
|
||||
content_payload = self._build_content_with_images(content_value, images, videos)
|
||||
else:
|
||||
content_payload = content_value
|
||||
message = {
|
||||
"role": "tool",
|
||||
"content": conv["content"],
|
||||
"content": content_payload,
|
||||
"tool_call_id": conv.get("tool_call_id", ""),
|
||||
"name": conv.get("name", "")
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user