Skip to content

协议 API

dcc_mcp_core.protocols 类型 — 符合 MCP 规范的类型定义。

ToolDefinition

字段类型说明
namestr工具名称
descriptionstr工具描述
input_schemastr输入的 JSON Schema 字符串(serde: inputSchema
output_schemaOptional[str]输出的 JSON Schema 字符串(serde: outputSchema
python
from dcc_mcp_core import ToolDefinition

tool = ToolDefinition(
    name="create_sphere",
    description="Creates a sphere",
    input_schema='{"type": "object"}',
)

ToolAnnotations

字段类型说明
titleOptional[str]人类可读标题
read_only_hintOptional[bool]serde: readOnlyHint
destructive_hintOptional[bool]serde: destructiveHint
idempotent_hintOptional[bool]serde: idempotentHint
open_world_hintOptional[bool]serde: openWorldHint
python
from dcc_mcp_core import ToolAnnotations

ann = ToolAnnotations(read_only_hint=True)

ResourceDefinition

字段类型默认值说明
uristr资源 URI
namestr资源名称
descriptionstr描述
mime_typestr"text/plain"MIME 类型(serde: mimeType
python
from dcc_mcp_core import ResourceDefinition

res = ResourceDefinition(uri="scene://objects", name="Objects", description="场景对象")

ResourceTemplateDefinition

字段类型默认值说明
uri_templatestrURI 模板(serde: uriTemplate
namestr模板名称
descriptionstr描述
mime_typestr"text/plain"MIME 类型(serde: mimeType
python
from dcc_mcp_core import ResourceTemplateDefinition

tmpl = ResourceTemplateDefinition(
    uri_template="scene://objects/{name}",
    name="Object",
    description="场景对象",
)

PromptArgument

字段类型默认值说明
namestr参数名称
descriptionstr描述
requiredboolFalse是否必需
python
from dcc_mcp_core import PromptArgument

arg = PromptArgument(name="object_name", description="要审查的对象", required=True)

PromptDefinition

字段类型说明
namestr提示名称
descriptionstr描述
python
from dcc_mcp_core import PromptDefinition

prompt = PromptDefinition(name="review", description="审查一个模型")

Released under the MIT License.