API Reference

This page contains the API reference documentation for skill-creator-mcp.

MCP Tools

Skill Creator MCP Server.

这是一个基于 FastMCP SDK 开发的 MCP Server，用于创建、验证、分析和重构 Agent-Skills。

Data Models

数据模型模块.

class skill_creator_mcp.models.InitResult(**data)[source]

Bases: BaseModel

初始化技能结果模型.

Parameters:: data (Any)

success: bool

skill_path: str

skill_name: str

template: Literal['minimal', 'tool-based', 'workflow-based', 'analyzer-based']

message: str

next_steps: list[str]

error: str | None

error_type: str | None

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class skill_creator_mcp.models.InitSkillInput(**data)[source]

Bases: BaseModel

初始化技能输入参数模型.

Parameters:: data (Any)

name: str

template: Literal['minimal', 'tool-based', 'workflow-based', 'analyzer-based']

output_dir: str

with_scripts: bool

with_examples: bool

classmethod validate_name(v)[source]

验证技能名称符合规范.

规范： - 只能包含小写字母、数字、连字符 - 不能以连字符开头或结尾 - 不能有连续的连字符

Parameters:: v (str) – 技能名称
Return type:: str
Returns:: 验证通过的技能名称
Raises:: ValueError – 名称不符合规范时抛出

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class skill_creator_mcp.models.SkillConfig(**data)[source]

Bases: BaseModel

技能配置模型.

Parameters:: data (Any)

name: str

template: Literal['minimal', 'tool-based', 'workflow-based', 'analyzer-based']

description: str | None

author: str | None

version: str

allowed_tools: list[str] | None

mcp_servers: list[str] | None

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Utility Functions

工具函数模块.

skill_creator_mcp.utils.validate_skill_name(name)[source]

验证技能名称符合规范.

规范： - 只能包含小写字母、数字、连字符 - 不能以连字符开头或结尾 - 不能有连续的连字符

Parameters:: name (str) – 技能名称
Raises:: ValueError – 名称不符合规范时抛出
Return type:: None

skill_creator_mcp.utils.validate_skill_directory(skill_dir)[source]

验证技能目录是否存在且结构正确.

Parameters:: skill_dir (Path) – 技能目录路径
Raises:: ValueError – 目录结构不正确时抛出
Return type:: None

skill_creator_mcp.utils.validate_template_type(template)[source]

验证模板类型是否有效.

Parameters:: template (str) – 模板类型
Return type:: str
Returns:: 验证通过的模板类型
Raises:: ValueError – 模板类型无效时抛出

async skill_creator_mcp.utils.create_directory_structure_async(name, template_type, output_dir)[source]

异步创建技能目录结构.

Parameters:

name (str) – 技能名称
template_type (str) – 模板类型
output_dir (Path) – 输出目录

Return type:

Path

Returns:

创建的技能目录路径

skill_creator_mcp.utils.create_directory_structure(name, template_type, output_dir)[source]

同步创建技能目录结构.

Parameters:

name (str) – 技能名称
template_type (str) – 模板类型
output_dir (Path) – 输出目录

Return type:

Path

Returns:

创建的技能目录路径

async skill_creator_mcp.utils.write_file_async(file_path, content, encoding='utf-8')[source]

异步写入文件.

Parameters:

file_path (Path) – 文件路径
content (str) – 文件内容
encoding (str, default: 'utf-8') – 文件编码

Return type:

None

skill_creator_mcp.utils.write_file(file_path, content, encoding='utf-8')[source]

同步写入文件.

Parameters:

file_path (Path) – 文件路径
content (str) – 文件内容
encoding (str, default: 'utf-8') – 文件编码

Return type:

None

async skill_creator_mcp.utils.read_file_async(file_path, encoding='utf-8')[source]

异步读取文件.

Parameters:

file_path (Path) – 文件路径
encoding (str, default: 'utf-8') – 文件编码

Return type:

str

Returns:

文件内容

skill_creator_mcp.utils.read_file(file_path, encoding='utf-8')[source]

同步读取文件.

Parameters:

file_path (Path) – 文件路径
encoding (str, default: 'utf-8') – 文件编码

Return type:

str

Returns:

文件内容

skill_creator_mcp.utils.generate_refactor_suggestions(skill_dir, structure, complexity, quality, focus_areas=None)[source]

生成重构建议.

Parameters:

skill_dir (Path) – 技能目录路径
structure (StructureAnalysis) – 结构分析结果
complexity (ComplexityMetrics) – 复杂度指标
quality (QualityScore) – 质量评分
focus_areas (list[str] | None, default: None) – 重点关注领域（可选）

Return type:

list[dict]

Returns:

重构建议列表（字典格式）

skill_creator_mcp.utils.generate_refactor_report(skill_path, structure, complexity, quality, suggestions)[source]

生成重构报告.

Parameters:

skill_path (str) – 技能路径
structure (StructureAnalysis) – 结构分析结果
complexity (ComplexityMetrics) – 复杂度指标
quality (QualityScore) – 质量评分
suggestions (list[dict]) – 重构建议

Return type:

str

Returns:

重构报告（Markdown 格式）

skill_creator_mcp.utils.estimate_refactor_effort(suggestions)[source]

估算重构工作量.

Parameters:: suggestions (list[dict]) – 重构建议列表
Return type:: dict[str, int]
Returns:: 工作量估算（按优先级分组的小时数）

skill_creator_mcp.utils.package_skill(skill_path, output_dir, package_format='zip', include_tests=True, validate_before_package=True)[source]

打包技能为分发格式.

Parameters:

skill_path (str) – 技能目录路径
output_dir (str) – 输出目录路径
package_format (str, default: 'zip') – 打包格式（zip/tar.gz/tar.bz2）
include_tests (bool, default: True) – 是否包含测试文件
validate_before_package (bool, default: True) – 打包前是否验证

Return type:

PackageResult

Returns:

打包结果

Resources

MCP Resources 模块.

提供静态资源访问，包括： - 技能模板 (skill://templates/{type}) - 最佳实践 (skill://best-practices) - 验证规则 (skill://validation-rules)

skill_creator_mcp.resources.get_template_content(template_type)[source]

获取指定模板类型的 SKILL.md 内容.

Parameters:: template_type (Literal['minimal', 'tool-based', 'workflow-based', 'analyzer-based']) – 模板类型
Return type:: str
Returns:: SKILL.md 模板内容

skill_creator_mcp.resources.list_templates()[source]

列出所有可用的模板类型.

Return type:: list[dict[str, str]]
Returns:: 模板类型列表，包含名称和描述

skill_creator_mcp.resources.get_best_practices()[source]

获取最佳实践文档内容.

Return type:: str
Returns:: 最佳实践 Markdown 内容

skill_creator_mcp.resources.get_validation_rules()[source]

获取验证规则文档内容.

Return type:: str
Returns:: 验证规则 Markdown 内容

Prompts

MCP Prompts 模块.

提供可重用的提示模板，用于指导 AI 完成特定任务。

skill_creator_mcp.prompts.get_create_skill_prompt(name, template='minimal')[source]

获取创建技能的 Prompt 模板.

Parameters:

name (str) – 技能名称
template (str, default: 'minimal') – 模板类型

Return type:

str

Returns:

Prompt 模板内容

skill_creator_mcp.prompts.get_validate_skill_prompt(skill_path, template_type=None)[source]

获取验证技能的 Prompt 模板.

Parameters:

skill_path (str) – 技能目录路径
template_type (str | None, default: None) – 模板类型（可选）

Return type:

str

Returns:

Prompt 模板内容

skill_creator_mcp.prompts.get_refactor_skill_prompt(skill_path, focus_areas=None)[source]

获取重构技能的 Prompt 模板.

Parameters:

skill_path (str) – 技能目录路径
focus_areas (list[str] | None, default: None) – 重点关注领域（可选）

Return type:

str

Returns:

Prompt 模板内容