feat(extension): 实现 Plugin Command 与 Settings Contribution #10
@@ -118,7 +118,7 @@ cd frontend
|
|||||||
pnpm test
|
pnpm test
|
||||||
```
|
```
|
||||||
|
|
||||||
当前回归基线为后端 107 项测试、前端 29 项测试,且 TypeScript 类型检查和生产构建通过。测试数量会随功能增长,以本地实际输出和 CI 为准。
|
当前回归基线为后端 116 项测试、前端 29 项测试,且 TypeScript 类型检查和生产构建通过。测试数量会随功能增长,以本地实际输出和 CI 为准。
|
||||||
|
|
||||||
构建产物位于 `frontend/dist`,该目录不提交到 Git。
|
构建产物位于 `frontend/dist`,该目录不提交到 Git。
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -23,7 +23,7 @@ uv run uvicorn app.main:app --reload --host 127.0.0.1 --port 8000
|
|||||||
uv run pytest
|
uv run pytest
|
||||||
```
|
```
|
||||||
|
|
||||||
当前基线为 107 项测试通过。Provider API Key 可通过前端设置页写入,也可用 `OPENAI_API_KEY`、`DEEPSEEK_API_KEY` 或 `AINOTE_CREDENTIAL_<ID>` 注入;不要把真实密钥写入仓库。`plugin.*` 是 Plugin Settings 的保留凭据命名空间,通用 Provider 凭据接口不能读写。
|
当前基线为 116 项测试通过。Provider API Key 可通过前端设置页写入,也可用 `OPENAI_API_KEY`、`DEEPSEEK_API_KEY` 或 `AINOTE_CREDENTIAL_<ID>` 注入;不要把真实密钥写入仓库。`plugin.*` 是 Plugin Settings 的保留凭据命名空间,通用 Provider 凭据接口不能读写。
|
||||||
|
|
||||||
团队接口清单见 `../docs/contracts/后端接口契约-开发版.md`,机器可读契约以运行时的 `/openapi.json` 为准。
|
团队接口清单见 `../docs/contracts/后端接口契约-开发版.md`,机器可读契约以运行时的 `/openapi.json` 为准。
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ from jsonschema import Draft202012Validator
|
|||||||
from jsonschema.exceptions import ValidationError as JsonSchemaValidationError
|
from jsonschema.exceptions import ValidationError as JsonSchemaValidationError
|
||||||
|
|
||||||
from app.contracts import ToolCall, ToolDefinition, ToolResult
|
from app.contracts import ToolCall, ToolDefinition, ToolResult
|
||||||
|
from app.schema_security import reject_external_schema_references
|
||||||
|
|
||||||
ToolExecutor = Callable[[BaseModel, "ToolExecutionContext"], Any | Awaitable[Any]]
|
ToolExecutor = Callable[[BaseModel, "ToolExecutionContext"], Any | Awaitable[Any]]
|
||||||
|
|
||||||
@@ -54,6 +55,7 @@ class ToolRegistry:
|
|||||||
arguments_model: type[BaseModel],
|
arguments_model: type[BaseModel],
|
||||||
executor: ToolExecutor,
|
executor: ToolExecutor,
|
||||||
) -> None:
|
) -> None:
|
||||||
|
reject_external_schema_references(definition.parameters)
|
||||||
with self._lock:
|
with self._lock:
|
||||||
if definition.name in self._tools:
|
if definition.name in self._tools:
|
||||||
raise ValueError(f"Tool already registered: {definition.name}")
|
raise ValueError(f"Tool already registered: {definition.name}")
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
|
import hashlib
|
||||||
import inspect
|
import inspect
|
||||||
import json
|
import json
|
||||||
import math
|
import math
|
||||||
@@ -17,7 +18,7 @@ from typing import Any, Awaitable, Callable, Literal
|
|||||||
|
|
||||||
from jsonschema import Draft202012Validator
|
from jsonschema import Draft202012Validator
|
||||||
from jsonschema.exceptions import SchemaError, ValidationError as JsonSchemaValidationError
|
from jsonschema.exceptions import SchemaError, ValidationError as JsonSchemaValidationError
|
||||||
from pydantic import BaseModel, ConfigDict, Field
|
from pydantic import BaseModel, ConfigDict, Field, model_validator
|
||||||
|
|
||||||
from app.config import get_settings
|
from app.config import get_settings
|
||||||
from app.contracts import (
|
from app.contracts import (
|
||||||
@@ -34,6 +35,10 @@ from app.contracts import (
|
|||||||
)
|
)
|
||||||
from app.extensions.errors import ExtensionError
|
from app.extensions.errors import ExtensionError
|
||||||
from app.providers.credentials import CredentialStoreError, EncryptedCredentialStore
|
from app.providers.credentials import CredentialStoreError, EncryptedCredentialStore
|
||||||
|
from app.schema_security import (
|
||||||
|
SchemaReferenceError,
|
||||||
|
reject_external_schema_references,
|
||||||
|
)
|
||||||
|
|
||||||
_CONTRIBUTION_ID = re.compile(r"^[a-z0-9][a-z0-9._-]*$")
|
_CONTRIBUTION_ID = re.compile(r"^[a-z0-9][a-z0-9._-]*$")
|
||||||
_SETTING_KEY = re.compile(r"^[a-z][a-z0-9._-]{0,127}$")
|
_SETTING_KEY = re.compile(r"^[a-z][a-z0-9._-]{0,127}$")
|
||||||
@@ -74,9 +79,16 @@ class PluginCommandSpec(BaseModel):
|
|||||||
)
|
)
|
||||||
permission: str | None = None
|
permission: str | None = None
|
||||||
secrets: list[str] = Field(default_factory=list)
|
secrets: list[str] = Field(default_factory=list)
|
||||||
handler: Literal["echo", "uppercase_selection"]
|
handler: Literal["echo", "uppercase_selection"] | None = None
|
||||||
|
mcp_tool: str | None = None
|
||||||
timeout_seconds: int = Field(default=30, ge=1, le=120)
|
timeout_seconds: int = Field(default=30, ge=1, le=120)
|
||||||
|
|
||||||
|
@model_validator(mode="after")
|
||||||
|
def validate_execution_target(self) -> "PluginCommandSpec":
|
||||||
|
if (self.handler is None) == (self.mcp_tool is None):
|
||||||
|
raise ValueError("Command must declare exactly one handler or mcp_tool target.")
|
||||||
|
return self
|
||||||
|
|
||||||
|
|
||||||
CommandExecutor = Callable[
|
CommandExecutor = Callable[
|
||||||
[dict[str, Any], dict[str, Any]],
|
[dict[str, Any], dict[str, Any]],
|
||||||
@@ -689,11 +701,13 @@ def validate_command_spec(plugin_id: str, spec: PluginCommandSpec) -> None:
|
|||||||
if spec.parameters.get("type", "object") != "object":
|
if spec.parameters.get("type", "object") != "object":
|
||||||
raise ExtensionError("PLUGIN_COMMAND_INVALID", "Command parameters must be an object schema.")
|
raise ExtensionError("PLUGIN_COMMAND_INVALID", "Command parameters must be an object schema.")
|
||||||
try:
|
try:
|
||||||
|
reject_external_schema_references(spec.parameters)
|
||||||
Draft202012Validator.check_schema(spec.parameters)
|
Draft202012Validator.check_schema(spec.parameters)
|
||||||
except SchemaError as exc:
|
except (SchemaReferenceError, SchemaError) as exc:
|
||||||
|
message = exc.message if isinstance(exc, SchemaError) else str(exc)
|
||||||
raise ExtensionError(
|
raise ExtensionError(
|
||||||
"PLUGIN_COMMAND_INVALID",
|
"PLUGIN_COMMAND_INVALID",
|
||||||
f"Plugin command parameters contain invalid JSON Schema: {exc.message}",
|
f"Plugin command parameters contain invalid JSON Schema: {message}",
|
||||||
) from exc
|
) from exc
|
||||||
|
|
||||||
|
|
||||||
@@ -746,7 +760,8 @@ def _secret_field(
|
|||||||
|
|
||||||
|
|
||||||
def _secret_reference(plugin_id: str, key: str) -> str:
|
def _secret_reference(plugin_id: str, key: str) -> str:
|
||||||
return f"plugin.{plugin_id}.{key}"
|
digest = hashlib.sha256(f"{plugin_id}\0{key}".encode("utf-8")).hexdigest()
|
||||||
|
return f"plugin.{digest}"
|
||||||
|
|
||||||
|
|
||||||
def _settings_schema_error(plugin_id: str, message: str) -> ExtensionError:
|
def _settings_schema_error(plugin_id: str, message: str) -> ExtensionError:
|
||||||
|
|||||||
@@ -29,6 +29,10 @@ from app.contracts import (
|
|||||||
PluginHostStatus,
|
PluginHostStatus,
|
||||||
ToolDefinition,
|
ToolDefinition,
|
||||||
)
|
)
|
||||||
|
from app.schema_security import (
|
||||||
|
SchemaReferenceError,
|
||||||
|
reject_external_schema_references,
|
||||||
|
)
|
||||||
|
|
||||||
MCP_PROTOCOL_VERSION = "2025-11-25"
|
MCP_PROTOCOL_VERSION = "2025-11-25"
|
||||||
SUPPORTED_PROTOCOL_VERSIONS = {
|
SUPPORTED_PROTOCOL_VERSIONS = {
|
||||||
@@ -676,11 +680,13 @@ class McpBridge:
|
|||||||
f"MCP tool inputSchema must be an object schema: {remote_name}",
|
f"MCP tool inputSchema must be an object schema: {remote_name}",
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
|
reject_external_schema_references(schema)
|
||||||
Draft202012Validator.check_schema(schema)
|
Draft202012Validator.check_schema(schema)
|
||||||
except SchemaError as exc:
|
except (SchemaReferenceError, SchemaError) as exc:
|
||||||
|
message = exc.message if isinstance(exc, SchemaError) else str(exc)
|
||||||
raise McpBridgeError(
|
raise McpBridgeError(
|
||||||
"MCP_TOOL_SCHEMA_INVALID",
|
"MCP_TOOL_SCHEMA_INVALID",
|
||||||
f"Invalid MCP tool schema for {remote_name}: {exc.message}",
|
f"Invalid MCP tool schema for {remote_name}: {message}",
|
||||||
) from exc
|
) from exc
|
||||||
metadata = raw.get("_meta")
|
metadata = raw.get("_meta")
|
||||||
permission = (
|
permission = (
|
||||||
|
|||||||
@@ -5,13 +5,14 @@ import threading
|
|||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any, Literal
|
from typing import Any, Literal
|
||||||
|
from uuid import uuid4
|
||||||
|
|
||||||
import yaml
|
import yaml
|
||||||
from jsonschema import Draft202012Validator
|
from jsonschema import Draft202012Validator
|
||||||
from jsonschema.exceptions import SchemaError
|
from jsonschema.exceptions import SchemaError
|
||||||
from pydantic import BaseModel, ConfigDict, Field, ValidationError, create_model
|
from pydantic import BaseModel, ConfigDict, Field, ValidationError, create_model
|
||||||
|
|
||||||
from app.agent.tools import ToolExecutionContext, ToolRegistry
|
from app.agent.tools import ToolExecutionContext, ToolExecutionError, ToolRegistry
|
||||||
from app.agent.permissions import KNOWN_PERMISSIONS
|
from app.agent.permissions import KNOWN_PERMISSIONS
|
||||||
from app.contracts import (
|
from app.contracts import (
|
||||||
ModelCapability,
|
ModelCapability,
|
||||||
@@ -45,6 +46,10 @@ from app.extensions.contributions import (
|
|||||||
from app.extensions.errors import ExtensionError
|
from app.extensions.errors import ExtensionError
|
||||||
from app.extensions.mcp import McpBridge, McpBridgeError, McpDiscoveredTool
|
from app.extensions.mcp import McpBridge, McpBridgeError, McpDiscoveredTool
|
||||||
from app.providers.credentials import EncryptedCredentialStore
|
from app.providers.credentials import EncryptedCredentialStore
|
||||||
|
from app.schema_security import (
|
||||||
|
SchemaReferenceError,
|
||||||
|
reject_external_schema_references,
|
||||||
|
)
|
||||||
|
|
||||||
_EXTENSION_ID = re.compile(r"^[a-z0-9][a-z0-9._-]*$")
|
_EXTENSION_ID = re.compile(r"^[a-z0-9][a-z0-9._-]*$")
|
||||||
|
|
||||||
@@ -410,6 +415,22 @@ class PluginRuntime:
|
|||||||
"Commands using Secret settings require the secrets.use permission.",
|
"Commands using Secret settings require the secrets.use permission.",
|
||||||
details={"command_id": spec.command_id},
|
details={"command_id": spec.command_id},
|
||||||
)
|
)
|
||||||
|
if spec.mcp_tool is not None:
|
||||||
|
_validate_id("MCP command target", spec.mcp_tool)
|
||||||
|
if manifest.backend.type != "mcp" or not spec.mcp_tool.startswith(
|
||||||
|
f"{manifest.plugin_id}."
|
||||||
|
):
|
||||||
|
raise ExtensionError(
|
||||||
|
"PLUGIN_COMMAND_INVALID",
|
||||||
|
"MCP Command target must use the current Plugin namespace.",
|
||||||
|
details={"command_id": spec.command_id},
|
||||||
|
)
|
||||||
|
if spec.mcp_tool in manifest.contributes.tools:
|
||||||
|
raise ExtensionError(
|
||||||
|
"PLUGIN_COMMAND_INVALID",
|
||||||
|
"MCP Command target cannot also be exposed as an Agent Tool.",
|
||||||
|
details={"command_id": spec.command_id},
|
||||||
|
)
|
||||||
|
|
||||||
record = _PluginRecord(
|
record = _PluginRecord(
|
||||||
plugin=Plugin(
|
plugin=Plugin(
|
||||||
@@ -492,14 +513,21 @@ class PluginRuntime:
|
|||||||
discovered = self._start_mcp(record)
|
discovered = self._start_mcp(record)
|
||||||
actual = {item.definition.name for item in discovered}
|
actual = {item.definition.name for item in discovered}
|
||||||
declared = set(declared_tools)
|
declared = set(declared_tools)
|
||||||
if actual != declared:
|
command_targets = {
|
||||||
|
spec.mcp_tool for spec in record.commands if spec.mcp_tool is not None
|
||||||
|
}
|
||||||
|
expected = declared | command_targets
|
||||||
|
if actual != expected:
|
||||||
raise ExtensionError(
|
raise ExtensionError(
|
||||||
"PLUGIN_CONTRIBUTION_INVALID",
|
"PLUGIN_CONTRIBUTION_INVALID",
|
||||||
"Discovered MCP tools must exactly match Plugin contributions.",
|
"Discovered MCP tools must exactly match Tool and Command targets.",
|
||||||
details={"declared": sorted(declared), "actual": sorted(actual)},
|
details={"declared": sorted(expected), "actual": sorted(actual)},
|
||||||
)
|
)
|
||||||
for item in discovered:
|
for item in discovered:
|
||||||
self._register_mcp_tool(record, item)
|
if item.definition.name in declared:
|
||||||
|
self._register_mcp_tool(record, item)
|
||||||
|
else:
|
||||||
|
record.mcp_remote_names[item.definition.name] = item.remote_name
|
||||||
else:
|
else:
|
||||||
for spec in record.tools:
|
for spec in record.tools:
|
||||||
arguments_model = _arguments_model(spec)
|
arguments_model = _arguments_model(spec)
|
||||||
@@ -549,6 +577,7 @@ class PluginRuntime:
|
|||||||
if _record.settings_definition is not None
|
if _record.settings_definition is not None
|
||||||
else {}
|
else {}
|
||||||
)
|
)
|
||||||
|
|
||||||
def resolve_secret(key: str) -> str | None:
|
def resolve_secret(key: str) -> str | None:
|
||||||
if key not in _spec.secrets:
|
if key not in _spec.secrets:
|
||||||
raise ExtensionError(
|
raise ExtensionError(
|
||||||
@@ -569,11 +598,62 @@ class PluginRuntime:
|
|||||||
)
|
)
|
||||||
if _record.settings_definition is None:
|
if _record.settings_definition is None:
|
||||||
return None
|
return None
|
||||||
return self.settings.resolve_secret(
|
value = self.settings.resolve_secret(
|
||||||
_record.plugin.manifest.plugin_id,
|
_record.plugin.manifest.plugin_id,
|
||||||
_record.settings_definition,
|
_record.settings_definition,
|
||||||
key,
|
key,
|
||||||
)
|
)
|
||||||
|
field = next(
|
||||||
|
item
|
||||||
|
for item in _record.settings_definition.fields
|
||||||
|
if item.key == key
|
||||||
|
)
|
||||||
|
if field.required and value is None:
|
||||||
|
raise ExtensionError(
|
||||||
|
"PLUGIN_SECRET_REQUIRED",
|
||||||
|
"A required Plugin Secret has not been configured.",
|
||||||
|
status_code=409,
|
||||||
|
details={"command_id": _spec.command_id, "key": key},
|
||||||
|
)
|
||||||
|
return value
|
||||||
|
|
||||||
|
if _spec.mcp_tool is not None:
|
||||||
|
remote_name = _record.mcp_remote_names[_spec.mcp_tool]
|
||||||
|
secret_values = {
|
||||||
|
key: value
|
||||||
|
for key in _spec.secrets
|
||||||
|
if (value := resolve_secret(key)) is not None
|
||||||
|
}
|
||||||
|
try:
|
||||||
|
effect = await self.mcp.call_tool(
|
||||||
|
_record.plugin.manifest.plugin_id,
|
||||||
|
remote_name,
|
||||||
|
{
|
||||||
|
"_notesagent": {
|
||||||
|
"command_id": _spec.command_id,
|
||||||
|
"arguments": arguments,
|
||||||
|
"context": context,
|
||||||
|
"secrets": secret_values,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
request_id=f"command:{uuid4().hex}",
|
||||||
|
)
|
||||||
|
except ToolExecutionError as exc:
|
||||||
|
raise ExtensionError(
|
||||||
|
exc.code,
|
||||||
|
"MCP Command target execution failed.",
|
||||||
|
status_code=502,
|
||||||
|
details={"command_id": _spec.command_id},
|
||||||
|
) from exc
|
||||||
|
try:
|
||||||
|
return PluginCommandEffect.model_validate(effect)
|
||||||
|
except ValidationError as exc:
|
||||||
|
raise ExtensionError(
|
||||||
|
"PLUGIN_COMMAND_RESULT_INVALID",
|
||||||
|
"MCP Command target returned an invalid effect.",
|
||||||
|
status_code=502,
|
||||||
|
details={"command_id": _spec.command_id},
|
||||||
|
) from exc
|
||||||
|
|
||||||
return await self.host.execute_command(
|
return await self.host.execute_command(
|
||||||
_spec.handler,
|
_spec.handler,
|
||||||
@@ -963,11 +1043,13 @@ def _arguments_model_from_schema(
|
|||||||
def _validate_tool_schema(spec: DeclarativeToolSpec) -> None:
|
def _validate_tool_schema(spec: DeclarativeToolSpec) -> None:
|
||||||
schema = spec.parameters or {"type": "object", "properties": {}}
|
schema = spec.parameters or {"type": "object", "properties": {}}
|
||||||
try:
|
try:
|
||||||
|
reject_external_schema_references(schema)
|
||||||
Draft202012Validator.check_schema(schema)
|
Draft202012Validator.check_schema(schema)
|
||||||
except SchemaError as exc:
|
except (SchemaReferenceError, SchemaError) as exc:
|
||||||
|
message = exc.message if isinstance(exc, SchemaError) else str(exc)
|
||||||
raise ExtensionError(
|
raise ExtensionError(
|
||||||
"PLUGIN_TOOL_SCHEMA_INVALID",
|
"PLUGIN_TOOL_SCHEMA_INVALID",
|
||||||
f"Invalid JSON Schema for tool {spec.name}: {exc.message}",
|
f"Invalid JSON Schema for tool {spec.name}: {message}",
|
||||||
details={"tool": spec.name},
|
details={"tool": spec.name},
|
||||||
) from exc
|
) from exc
|
||||||
if schema.get("type", "object") != "object" or not isinstance(
|
if schema.get("type", "object") != "object" or not isinstance(
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
"""共享 JSON Schema 安全约束。"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
from urllib.parse import unquote
|
||||||
|
|
||||||
|
|
||||||
|
class SchemaReferenceError(ValueError):
|
||||||
|
"""Schema 引用不符合宿主的离线、文档内解析约束。"""
|
||||||
|
|
||||||
|
|
||||||
|
class ExternalSchemaReferenceError(SchemaReferenceError):
|
||||||
|
def __init__(self, keyword: str, reference: Any) -> None:
|
||||||
|
super().__init__(f"External JSON Schema reference is not allowed: {reference!r}")
|
||||||
|
self.keyword = keyword
|
||||||
|
self.reference = reference
|
||||||
|
|
||||||
|
|
||||||
|
class UnresolvableLocalSchemaReferenceError(SchemaReferenceError):
|
||||||
|
def __init__(self, reference: str) -> None:
|
||||||
|
super().__init__(f"Local JSON Schema reference cannot be resolved: {reference!r}")
|
||||||
|
self.reference = reference
|
||||||
|
|
||||||
|
|
||||||
|
def reject_external_schema_references(schema: Any) -> None:
|
||||||
|
"""只允许可解析的文档内 Fragment,禁止文件和网络检索。"""
|
||||||
|
|
||||||
|
pending = [schema]
|
||||||
|
local_references: list[str] = []
|
||||||
|
anchors: set[str] = set()
|
||||||
|
while pending:
|
||||||
|
value = pending.pop()
|
||||||
|
if isinstance(value, dict):
|
||||||
|
for key, child in value.items():
|
||||||
|
if key in {"$ref", "$dynamicRef"}:
|
||||||
|
if not isinstance(child, str) or not child.startswith("#"):
|
||||||
|
raise ExternalSchemaReferenceError(key, child)
|
||||||
|
local_references.append(child)
|
||||||
|
elif key in {"$anchor", "$dynamicAnchor"} and isinstance(child, str):
|
||||||
|
anchors.add(child)
|
||||||
|
pending.append(child)
|
||||||
|
elif isinstance(value, list):
|
||||||
|
pending.extend(value)
|
||||||
|
|
||||||
|
for reference in local_references:
|
||||||
|
if not _local_reference_exists(schema, reference, anchors):
|
||||||
|
raise UnresolvableLocalSchemaReferenceError(reference)
|
||||||
|
|
||||||
|
|
||||||
|
def _local_reference_exists(schema: Any, reference: str, anchors: set[str]) -> bool:
|
||||||
|
fragment = unquote(reference[1:])
|
||||||
|
if not fragment:
|
||||||
|
return True
|
||||||
|
if not fragment.startswith("/"):
|
||||||
|
return fragment in anchors
|
||||||
|
|
||||||
|
current = schema
|
||||||
|
for encoded_segment in fragment[1:].split("/"):
|
||||||
|
segment = encoded_segment.replace("~1", "/").replace("~0", "~")
|
||||||
|
if isinstance(current, dict) and segment in current:
|
||||||
|
current = current[segment]
|
||||||
|
elif isinstance(current, list) and segment.isdecimal():
|
||||||
|
index = int(segment)
|
||||||
|
if index >= len(current):
|
||||||
|
return False
|
||||||
|
current = current[index]
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
return True
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
commands:
|
||||||
|
- command_id: mcp-fixture.notify
|
||||||
|
title: MCP 通知
|
||||||
|
description: 通过隔离 MCP Host 返回宿主白名单通知 effect。
|
||||||
|
icon: bolt
|
||||||
|
locations:
|
||||||
|
- command_palette
|
||||||
|
when:
|
||||||
|
- editor.has_selection
|
||||||
|
context:
|
||||||
|
- selection
|
||||||
|
secrets:
|
||||||
|
- api_key
|
||||||
|
mcp_tool: mcp-fixture.command
|
||||||
|
parameters:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
additionalProperties: false
|
||||||
@@ -1,9 +1,10 @@
|
|||||||
id: mcp-fixture
|
id: mcp-fixture
|
||||||
name: MCP Fixture
|
name: MCP Fixture
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
description: 阶段 C 离线联调 Fixture,覆盖 MCP Tool 生命周期与错误边界。
|
description: 阶段 C/D 离线联调 Fixture,覆盖 MCP Tool、Command 与错误边界。
|
||||||
permissions:
|
permissions:
|
||||||
- notes.read
|
- notes.read
|
||||||
|
- secrets.use
|
||||||
contributes:
|
contributes:
|
||||||
tools:
|
tools:
|
||||||
- mcp-fixture.echo
|
- mcp-fixture.echo
|
||||||
@@ -12,6 +13,10 @@ contributes:
|
|||||||
- mcp-fixture.large
|
- mcp-fixture.large
|
||||||
- mcp-fixture.environment
|
- mcp-fixture.environment
|
||||||
- mcp-fixture.exit
|
- mcp-fixture.exit
|
||||||
|
commands:
|
||||||
|
- mcp-fixture.notify
|
||||||
|
settings_sections:
|
||||||
|
- mcp-fixture.general
|
||||||
backend:
|
backend:
|
||||||
type: mcp
|
type: mcp
|
||||||
transport: stdio
|
transport: stdio
|
||||||
|
|||||||
@@ -54,6 +54,11 @@ TOOLS = {
|
|||||||
"large": tool("large", "Return a result larger than the host limit."),
|
"large": tool("large", "Return a result larger than the host limit."),
|
||||||
"environment": tool("environment", "Report whether host secrets leaked into the process."),
|
"environment": tool("environment", "Report whether host secrets leaked into the process."),
|
||||||
"exit": tool("exit", "Terminate the fixture process."),
|
"exit": tool("exit", "Terminate the fixture process."),
|
||||||
|
"command": tool(
|
||||||
|
"command",
|
||||||
|
"Execute a NotesAgent Plugin Command envelope.",
|
||||||
|
{"_notesagent": {"type": "object"}},
|
||||||
|
),
|
||||||
}
|
}
|
||||||
# suffix 是可选字段,用于验证 Host 不会把缺省值擅自补成 null。
|
# suffix 是可选字段,用于验证 Host 不会把缺省值擅自补成 null。
|
||||||
TOOLS["echo"]["inputSchema"]["required"] = ["text"]
|
TOOLS["echo"]["inputSchema"]["required"] = ["text"]
|
||||||
@@ -62,6 +67,28 @@ TOOLS["echo"]["inputSchema"]["required"] = ["text"]
|
|||||||
def call_tool(request_id: int, params: dict[str, Any]) -> None:
|
def call_tool(request_id: int, params: dict[str, Any]) -> None:
|
||||||
name = params.get("name")
|
name = params.get("name")
|
||||||
arguments = params.get("arguments") or {}
|
arguments = params.get("arguments") or {}
|
||||||
|
if name == "command":
|
||||||
|
envelope = arguments.get("_notesagent") or {}
|
||||||
|
command_arguments = envelope.get("arguments") or {}
|
||||||
|
context = envelope.get("context") or {}
|
||||||
|
secrets = envelope.get("secrets") or {}
|
||||||
|
message = command_arguments.get("message") or context.get("selection") or ""
|
||||||
|
respond(
|
||||||
|
request_id,
|
||||||
|
{
|
||||||
|
"content": [{"type": "text", "text": "command completed"}],
|
||||||
|
"structuredContent": {
|
||||||
|
"type": "notification",
|
||||||
|
"payload": {
|
||||||
|
"level": "success",
|
||||||
|
"message": str(message),
|
||||||
|
"secret_configured": isinstance(secrets.get("api_key"), str),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"isError": False,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
return
|
||||||
if name == "echo":
|
if name == "echo":
|
||||||
text = str(arguments.get("text", ""))
|
text = str(arguments.get("text", ""))
|
||||||
structured_content = {"echo": text}
|
structured_content = {"echo": text}
|
||||||
@@ -183,7 +210,14 @@ def main() -> None:
|
|||||||
elif params.get("cursor") == "page-2":
|
elif params.get("cursor") == "page-2":
|
||||||
respond(
|
respond(
|
||||||
request_id,
|
request_id,
|
||||||
{"tools": [TOOLS["large"], TOOLS["environment"], TOOLS["exit"]]},
|
{
|
||||||
|
"tools": [
|
||||||
|
TOOLS["large"],
|
||||||
|
TOOLS["environment"],
|
||||||
|
TOOLS["exit"],
|
||||||
|
TOOLS["command"],
|
||||||
|
]
|
||||||
|
},
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
respond(
|
respond(
|
||||||
|
|||||||
@@ -0,0 +1,7 @@
|
|||||||
|
section_id: mcp-fixture.general
|
||||||
|
schema_version: 1
|
||||||
|
fields:
|
||||||
|
- key: api_key
|
||||||
|
label: Fixture API Key
|
||||||
|
type: secret
|
||||||
|
required: true
|
||||||
@@ -11,6 +11,7 @@ from app.container import build_container
|
|||||||
from app.contracts import (
|
from app.contracts import (
|
||||||
AgentRunCreateRequest,
|
AgentRunCreateRequest,
|
||||||
AgentRunStatus,
|
AgentRunStatus,
|
||||||
|
PluginCommandContext,
|
||||||
SkillStatus,
|
SkillStatus,
|
||||||
ToolCall,
|
ToolCall,
|
||||||
)
|
)
|
||||||
@@ -33,7 +34,7 @@ def mcp_container():
|
|||||||
container = build_container()
|
container = build_container()
|
||||||
installed = container.plugins.install(MCP_FIXTURE)
|
installed = container.plugins.install(MCP_FIXTURE)
|
||||||
assert installed.status == "permission_required"
|
assert installed.status == "permission_required"
|
||||||
container.plugins.set_permissions("mcp-fixture", ["notes.read"])
|
container.plugins.set_permissions("mcp-fixture", ["notes.read", "secrets.use"])
|
||||||
try:
|
try:
|
||||||
yield container
|
yield container
|
||||||
finally:
|
finally:
|
||||||
@@ -349,7 +350,7 @@ def test_mcp_stdio_host_discovers_namespaced_tools_and_maps_results(
|
|||||||
ToolExecutionContext(run_id="run_mcp_fixture"),
|
ToolExecutionContext(run_id="run_mcp_fixture"),
|
||||||
)
|
)
|
||||||
|
|
||||||
assert status.tools_count == 6
|
assert status.tools_count == 7
|
||||||
assert status.protocol_version == "2025-11-25"
|
assert status.protocol_version == "2025-11-25"
|
||||||
assert status.server_name == "notesagent-mcp-fixture"
|
assert status.server_name == "notesagent-mcp-fixture"
|
||||||
assert definition.permission == "notes.read"
|
assert definition.permission == "notes.read"
|
||||||
@@ -396,6 +397,46 @@ def test_mcp_stdio_host_discovers_namespaced_tools_and_maps_results(
|
|||||||
run(scenario())
|
run(scenario())
|
||||||
|
|
||||||
|
|
||||||
|
def test_mcp_command_target_receives_scoped_context_and_declared_secret(
|
||||||
|
mcp_container,
|
||||||
|
) -> None:
|
||||||
|
async def scenario() -> None:
|
||||||
|
mcp_container.plugins.enable("mcp-fixture")
|
||||||
|
|
||||||
|
assert not mcp_container.tools.contains("mcp-fixture.command")
|
||||||
|
with pytest.raises(ExtensionError) as missing:
|
||||||
|
await mcp_container.plugins.execute_command(
|
||||||
|
"mcp-fixture.notify",
|
||||||
|
{},
|
||||||
|
PluginCommandContext(selection="来自选区"),
|
||||||
|
)
|
||||||
|
assert missing.value.code == "PLUGIN_SECRET_REQUIRED"
|
||||||
|
|
||||||
|
mcp_container.plugins.put_setting_secret(
|
||||||
|
"mcp-fixture", "api_key", "mcp-command-secret"
|
||||||
|
)
|
||||||
|
result = await mcp_container.plugins.execute_command(
|
||||||
|
"mcp-fixture.notify",
|
||||||
|
{},
|
||||||
|
PluginCommandContext(
|
||||||
|
note_id="must-not-enter-envelope",
|
||||||
|
selection="来自选区",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert result.effect.type == "notification"
|
||||||
|
assert result.effect.payload == {
|
||||||
|
"level": "success",
|
||||||
|
"message": "来自选区",
|
||||||
|
"secret_configured": True,
|
||||||
|
}
|
||||||
|
assert "mcp-command-secret" not in repr(
|
||||||
|
mcp_container.plugins.commands.audit_events()
|
||||||
|
)
|
||||||
|
|
||||||
|
run(scenario())
|
||||||
|
|
||||||
|
|
||||||
def test_agent_calls_mcp_tool_through_registry_and_writes_trace(mcp_container) -> None:
|
def test_agent_calls_mcp_tool_through_registry_and_writes_trace(mcp_container) -> None:
|
||||||
async def scenario() -> None:
|
async def scenario() -> None:
|
||||||
mcp_container.plugins.enable("mcp-fixture")
|
mcp_container.plugins.enable("mcp-fixture")
|
||||||
@@ -531,7 +572,7 @@ def test_production_rejects_unsandboxed_mcp_host(monkeypatch) -> None:
|
|||||||
container = build_container()
|
container = build_container()
|
||||||
installed = container.plugins.install(MCP_FIXTURE)
|
installed = container.plugins.install(MCP_FIXTURE)
|
||||||
assert installed.status == "permission_required"
|
assert installed.status == "permission_required"
|
||||||
container.plugins.set_permissions("mcp-fixture", ["notes.read"])
|
container.plugins.set_permissions("mcp-fixture", ["notes.read", "secrets.use"])
|
||||||
try:
|
try:
|
||||||
with pytest.raises(ExtensionError) as exc:
|
with pytest.raises(ExtensionError) as exc:
|
||||||
container.plugins.enable("mcp-fixture")
|
container.plugins.enable("mcp-fixture")
|
||||||
@@ -565,7 +606,7 @@ def test_mcp_abnormal_exit_unregisters_tools_and_restart_recovers(mcp_container)
|
|||||||
|
|
||||||
restarted = mcp_container.plugins.restart_host("mcp-fixture")
|
restarted = mcp_container.plugins.restart_host("mcp-fixture")
|
||||||
assert restarted.status == "ready"
|
assert restarted.status == "ready"
|
||||||
assert restarted.tools_count == 6
|
assert restarted.tools_count == 7
|
||||||
assert mcp_container.tools.contains("mcp-fixture.echo")
|
assert mcp_container.tools.contains("mcp-fixture.echo")
|
||||||
|
|
||||||
run(scenario())
|
run(scenario())
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ from app.contracts import (
|
|||||||
PluginSettingType,
|
PluginSettingType,
|
||||||
)
|
)
|
||||||
from app.extensions import ExtensionError, PluginRuntime
|
from app.extensions import ExtensionError, PluginRuntime
|
||||||
|
from app.extensions.contributions import _secret_reference
|
||||||
from app.extensions.runtime import DeclarativePluginHost
|
from app.extensions.runtime import DeclarativePluginHost
|
||||||
|
|
||||||
TEXT_TOOLS = BACKEND_DIR / "extensions" / "plugins" / "text-tools"
|
TEXT_TOOLS = BACKEND_DIR / "extensions" / "plugins" / "text-tools"
|
||||||
@@ -260,24 +261,39 @@ def test_secret_roundtrip_never_enters_plain_settings_storage() -> None:
|
|||||||
assert "api_key" not in schema.values
|
assert "api_key" not in schema.values
|
||||||
assert plaintext not in settings_path.read_text(encoding="utf-8")
|
assert plaintext not in settings_path.read_text(encoding="utf-8")
|
||||||
assert plaintext not in credentials_path.read_text(encoding="utf-8")
|
assert plaintext not in credentials_path.read_text(encoding="utf-8")
|
||||||
assert container.credentials.resolve("plugin.text-tools.api_key") == plaintext
|
stored_settings = json.loads(settings_path.read_text(encoding="utf-8"))
|
||||||
|
reference = stored_settings["text-tools"]["secret_refs"]["api_key"]
|
||||||
|
assert reference.startswith("plugin.")
|
||||||
|
assert len(reference) == 71
|
||||||
|
assert "text-tools" not in reference and "api_key" not in reference
|
||||||
|
assert container.credentials.resolve(reference) == plaintext
|
||||||
|
|
||||||
deleted = container.plugins.delete_setting_secret("text-tools", "api_key")
|
deleted = container.plugins.delete_setting_secret("text-tools", "api_key")
|
||||||
assert deleted.configured is False
|
assert deleted.configured is False
|
||||||
assert container.credentials.resolve("plugin.text-tools.api_key") is None
|
assert container.credentials.resolve(reference) is None
|
||||||
|
|
||||||
|
|
||||||
def test_uninstall_removes_plugin_settings_and_secret_namespace() -> None:
|
def test_uninstall_removes_plugin_settings_and_secret_namespace() -> None:
|
||||||
container = build_container()
|
container = build_container()
|
||||||
container.plugins.update_settings("text-tools", 1, {"result_limit": 12})
|
container.plugins.update_settings("text-tools", 1, {"result_limit": 12})
|
||||||
container.plugins.put_setting_secret("text-tools", "api_key", "temporary")
|
container.plugins.put_setting_secret("text-tools", "api_key", "temporary")
|
||||||
|
settings_path = get_settings().data_dir / "plugins" / "settings.json"
|
||||||
|
reference = json.loads(settings_path.read_text(encoding="utf-8"))[
|
||||||
|
"text-tools"
|
||||||
|
]["secret_refs"]["api_key"]
|
||||||
|
|
||||||
container.plugins.uninstall("text-tools")
|
container.plugins.uninstall("text-tools")
|
||||||
|
|
||||||
settings_path = get_settings().data_dir / "plugins" / "settings.json"
|
|
||||||
stored = json.loads(settings_path.read_text(encoding="utf-8"))
|
stored = json.loads(settings_path.read_text(encoding="utf-8"))
|
||||||
assert "text-tools" not in stored
|
assert "text-tools" not in stored
|
||||||
assert container.credentials.resolve("plugin.text-tools.api_key") is None
|
assert container.credentials.resolve(reference) is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_plugin_secret_reference_has_fixed_credential_safe_length() -> None:
|
||||||
|
reference = _secret_reference("p" * 512, "k" * 128)
|
||||||
|
|
||||||
|
assert reference.startswith("plugin.")
|
||||||
|
assert len(reference) <= 128
|
||||||
|
|
||||||
|
|
||||||
def test_invalid_command_and_settings_manifest_are_rejected(tmp_path: Path) -> None:
|
def test_invalid_command_and_settings_manifest_are_rejected(tmp_path: Path) -> None:
|
||||||
@@ -363,6 +379,42 @@ backend:
|
|||||||
assert exc.value.code == "EXTENSION_MANIFEST_INVALID"
|
assert exc.value.code == "EXTENSION_MANIFEST_INVALID"
|
||||||
|
|
||||||
|
|
||||||
|
def test_external_command_schema_reference_is_rejected(tmp_path: Path) -> None:
|
||||||
|
package = tmp_path / "external-ref"
|
||||||
|
package.mkdir()
|
||||||
|
(package / "plugin.yaml").write_text(
|
||||||
|
"""
|
||||||
|
id: external-ref
|
||||||
|
name: External Ref
|
||||||
|
version: 1.0.0
|
||||||
|
contributes:
|
||||||
|
commands: [external-ref.run]
|
||||||
|
backend:
|
||||||
|
type: internal_rpc
|
||||||
|
transport: none
|
||||||
|
""".strip(),
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
(package / "commands.yaml").write_text(
|
||||||
|
"""
|
||||||
|
commands:
|
||||||
|
- command_id: external-ref.run
|
||||||
|
title: External Ref
|
||||||
|
locations: [command_palette]
|
||||||
|
handler: echo
|
||||||
|
parameters:
|
||||||
|
$ref: file:///host/private-schema.json
|
||||||
|
""".strip(),
|
||||||
|
encoding="utf-8",
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(ExtensionError) as exc:
|
||||||
|
PluginRuntime(ToolRegistry()).install(package)
|
||||||
|
|
||||||
|
assert exc.value.code == "PLUGIN_COMMAND_INVALID"
|
||||||
|
assert "External JSON Schema reference" in exc.value.message
|
||||||
|
|
||||||
|
|
||||||
def test_settings_missing_and_secret_field_errors_are_stable() -> None:
|
def test_settings_missing_and_secret_field_errors_are_stable() -> None:
|
||||||
container = build_container()
|
container = build_container()
|
||||||
|
|
||||||
@@ -394,4 +446,10 @@ def test_corrupted_plugin_settings_namespace_returns_stable_error() -> None:
|
|||||||
container.plugins.put_setting_secret("text-tools", "api_key", "must-not-orphan")
|
container.plugins.put_setting_secret("text-tools", "api_key", "must-not-orphan")
|
||||||
|
|
||||||
assert secret_exc.value.code == "PLUGIN_STORAGE_ERROR"
|
assert secret_exc.value.code == "PLUGIN_STORAGE_ERROR"
|
||||||
assert container.credentials.resolve("plugin.text-tools.api_key") is None
|
credentials_path = get_settings().data_dir / "credentials" / "credentials.json"
|
||||||
|
credential_ids = (
|
||||||
|
json.loads(credentials_path.read_text(encoding="utf-8")).keys()
|
||||||
|
if credentials_path.exists()
|
||||||
|
else []
|
||||||
|
)
|
||||||
|
assert not any(item.startswith("plugin.") for item in credential_ids)
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
import pytest
|
||||||
|
|
||||||
|
from app.schema_security import (
|
||||||
|
ExternalSchemaReferenceError,
|
||||||
|
UnresolvableLocalSchemaReferenceError,
|
||||||
|
reject_external_schema_references,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"schema",
|
||||||
|
[
|
||||||
|
{"$ref": "file:///host/private-schema.json"},
|
||||||
|
{"properties": {"value": {"$ref": "https://schema.invalid/value.json"}}},
|
||||||
|
{"allOf": [{"$dynamicRef": "https://schema.invalid/dynamic"}]},
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_external_json_schema_references_are_rejected(schema) -> None:
|
||||||
|
with pytest.raises(ExternalSchemaReferenceError):
|
||||||
|
reject_external_schema_references(schema)
|
||||||
|
|
||||||
|
|
||||||
|
def test_local_json_schema_fragment_reference_is_allowed() -> None:
|
||||||
|
reject_external_schema_references(
|
||||||
|
{
|
||||||
|
"$defs": {"value": {"type": "string"}},
|
||||||
|
"properties": {"value": {"$ref": "#/$defs/value"}},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize("reference", ["#/$defs/missing", "#missing-anchor"])
|
||||||
|
def test_unresolvable_local_schema_reference_is_rejected(reference: str) -> None:
|
||||||
|
with pytest.raises(UnresolvableLocalSchemaReferenceError):
|
||||||
|
reject_external_schema_references({"type": "object", "$ref": reference})
|
||||||
@@ -2329,7 +2329,7 @@ Markdown Workspace
|
|||||||
|
|
||||||
第一阶段 Plugin Runtime 已完成安装、启用、停用、权限和声明式 Tool 注册,建立 Skill 调用 Plugin Tool 的基础链路。Command、Settings 和 MCP 执行不计入第一阶段完成项。
|
第一阶段 Plugin Runtime 已完成安装、启用、停用、权限和声明式 Tool 注册,建立 Skill 调用 Plugin Tool 的基础链路。Command、Settings 和 MCP 执行不计入第一阶段完成项。
|
||||||
|
|
||||||
截至 2026-09-02,上述第一阶段后端链路和 Web 联调前端均已完成;第二阶段前置的 Workspace 去 Mock 联调、Agent Trace 持久化/恢复接口、stdio MCP Bridge / Plugin Host 以及 Plugin Command/Settings 后端 Contract 也已完成。当前验证基线为后端 107 项测试、前端 29 项测试、TypeScript 类型检查及生产构建通过。向量链路当前使用 `HashEmbeddingProvider` 验证工程正确性,真实 Embedding 召回质量不属于该测试结论。
|
截至 2026-09-02,上述第一阶段后端链路和 Web 联调前端均已完成;第二阶段前置的 Workspace 去 Mock 联调、Agent Trace 持久化/恢复接口、stdio MCP Bridge / Plugin Host 以及 Plugin Command/Settings 后端 Contract 也已完成。当前验证基线为后端 116 项测试、前端 29 项测试、TypeScript 类型检查及生产构建通过。向量链路当前使用 `HashEmbeddingProvider` 验证工程正确性,真实 Embedding 召回质量不属于该测试结论。
|
||||||
|
|
||||||
第二阶段在既有 Contract 上接入:
|
第二阶段在既有 Contract 上接入:
|
||||||
|
|
||||||
|
|||||||
@@ -176,7 +176,7 @@ RunCancelled
|
|||||||
|
|
||||||
## 当前实现状态
|
## 当前实现状态
|
||||||
|
|
||||||
更新至 2026-09-02:后端 107 项回归测试通过;第二阶段 Plugin Command 与 Plugin Settings/Secret 接口已实现,详细 DTO 和边界见《第二阶段接口契约-开发版》第 7 节。
|
更新至 2026-09-02:后端 116 项回归测试通过;第二阶段 Plugin Command 与 Plugin Settings/Secret 接口已实现,详细 DTO 和边界见《第二阶段接口契约-开发版》第 7 节。
|
||||||
|
|
||||||
- Chat、Agent Run、Agent Events、Tool 列表、Provider 配置生命周期、模型列表和连接测试已经接入 AI Core。
|
- Chat、Agent Run、Agent Events、Tool 列表、Provider 配置生命周期、模型列表和连接测试已经接入 AI Core。
|
||||||
- Agent Run/Event 已持久化到 SQLite;SSE 帧携带 sequence `id`,断线后可以回放缺失事件。Trace API 与 Benchmark 共用同一事件事实,并在入库前执行 Secret 脱敏和结果限长。
|
- Agent Run/Event 已持久化到 SQLite;SSE 帧携带 sequence `id`,断线后可以回放缺失事件。Trace API 与 Benchmark 共用同一事件事实,并在入库前执行 Secret 脱敏和结果限长。
|
||||||
|
|||||||
@@ -544,7 +544,9 @@ error
|
|||||||
|
|
||||||
当前宿主只注册已启用且已满足权限授权的 Plugin Command。执行前按 JSON Schema 校验参数、按 `when` 校验上下文,再根据 Command 声明裁剪 Context;单次执行默认超时 30 秒,effect 的 JSON 编码结果不得超过 64 KiB。宿主保留最多 500 条轻量审计事件,仅记录 Command、Plugin、状态、耗时和错误码,不记录 arguments、Context、effect 或 Secret。
|
当前宿主只注册已启用且已满足权限授权的 Plugin Command。执行前按 JSON Schema 校验参数、按 `when` 校验上下文,再根据 Command 声明裁剪 Context;单次执行默认超时 30 秒,effect 的 JSON 编码结果不得超过 64 KiB。宿主保留最多 500 条轻量审计事件,仅记录 Command、Plugin、状态、耗时和错误码,不记录 arguments、Context、effect 或 Secret。
|
||||||
|
|
||||||
需要 Secret 的 Command 必须在 `commands.yaml` 的内部 `secrets` 数组中声明对应 Setting Key,并在 Plugin Manifest 声明 `secrets.use` 权限。安装时宿主校验该字段确实属于当前 Plugin Settings Schema 的 `secret` 类型;只有权限已授予并启用后,运行时才向受控 handler 提供按需 Resolver,未声明字段返回 `PLUGIN_SECRET_ACCESS_DENIED`。`secrets` 不属于前端 `PluginCommand` DTO,Secret 明文也不会并入普通 Settings 字典。
|
需要 Secret 的 Command 必须在 `commands.yaml` 的内部 `secrets` 数组中声明对应 Setting Key,并在 Plugin Manifest 声明 `secrets.use` 权限。安装时宿主校验该字段确实属于当前 Plugin Settings Schema 的 `secret` 类型;只有权限已授予并启用后,运行时才向受控 handler 或 MCP Command Target 提供声明过的 Secret。未声明字段返回 `PLUGIN_SECRET_ACCESS_DENIED`,必填 Secret 未配置返回 `PLUGIN_SECRET_REQUIRED`。`secrets` 不属于前端 `PluginCommand` DTO,Secret 明文也不会并入普通 Settings 字典。
|
||||||
|
|
||||||
|
`commands.yaml` 中的执行目标必须在宿主白名单 `handler` 与当前 Plugin 命名空间的 `mcp_tool` 之间二选一。MCP Command Target 不注册为 Agent Tool;宿主用 `_notesagent` 保留包装传入 Command ID、参数、裁剪后的 Context 和声明过的 Secret,并将 MCP structured result 再校验为白名单 effect。Command 与 Tool Schema 仅允许 `#...` 文档内引用,任何通过 `$ref` 或 `$dynamicRef` 指向文件、HTTP 或其他外部资源的 Schema 都会在注册前被拒绝。
|
||||||
|
|
||||||
### 7.5 Settings Schema
|
### 7.5 Settings Schema
|
||||||
|
|
||||||
@@ -627,7 +629,7 @@ DELETE /api/plugins/{plugin_id}/settings/{key}/secret
|
|||||||
|
|
||||||
Secret 明文不进入普通 Settings、日志、Trace、Benchmark Dataset 或前端持久化。
|
Secret 明文不进入普通 Settings、日志、Trace、Benchmark Dataset 或前端持久化。
|
||||||
|
|
||||||
非敏感值按 `plugin_id` 写入 `APP_DATA_DIR/plugins/settings.json`。该文件只保存普通值、Schema 版本和确定性的 Secret Reference;Secret 本身由宿主凭据存储加密保存。卸载 Plugin 时同时清理它的 Settings 命名空间和 Secret Reference。当前开发阶段使用 Fernet 文件凭据存储,第三阶段接入桌面 Host 后应迁移到 Stronghold 或系统 Keychain。
|
非敏感值按 `plugin_id` 写入 `APP_DATA_DIR/plugins/settings.json`。该文件只保存普通值、Schema 版本和确定性的定长 Secret Reference,格式为 `plugin.<sha256(plugin_id\\0setting_key)>`;Secret 本身由宿主凭据存储加密保存。卸载 Plugin 时同时清理它的 Settings 命名空间和 Secret Reference。当前开发阶段使用 Fernet 文件凭据存储,第三阶段接入桌面 Host 后应迁移到 Stronghold 或系统 Keychain。
|
||||||
|
|
||||||
`plugin.*` 为宿主保留凭据命名空间。`/api/credentials/{credential_id}`、Provider 持久配置、Provider 临时测试凭据和 Provider Resolver 均拒绝该前缀,防止通过 Provider 链路覆盖、删除或向外部 Base URL 发送 Plugin Secret。
|
`plugin.*` 为宿主保留凭据命名空间。`/api/credentials/{credential_id}`、Provider 持久配置、Provider 临时测试凭据和 Provider Resolver 均拒绝该前缀,防止通过 Provider 链路覆盖、删除或向外部 Base URL 发送 Plugin Secret。
|
||||||
|
|
||||||
@@ -657,6 +659,7 @@ PLUGIN_SETTINGS_VERSION_CONFLICT
|
|||||||
PLUGIN_SETTINGS_FIELD_INVALID
|
PLUGIN_SETTINGS_FIELD_INVALID
|
||||||
PLUGIN_SECRET_FIELD_NOT_FOUND
|
PLUGIN_SECRET_FIELD_NOT_FOUND
|
||||||
PLUGIN_SECRET_ACCESS_DENIED
|
PLUGIN_SECRET_ACCESS_DENIED
|
||||||
|
PLUGIN_SECRET_REQUIRED
|
||||||
PLUGIN_SECRET_VALUE_INVALID
|
PLUGIN_SECRET_VALUE_INVALID
|
||||||
PLUGIN_SECRET_STORE_ERROR
|
PLUGIN_SECRET_STORE_ERROR
|
||||||
PLUGIN_STORAGE_ERROR
|
PLUGIN_STORAGE_ERROR
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
> 本文档用于团队开发和模块联调,记录当前已经落地的核心边界与使用方式。
|
> 本文档用于团队开发和模块联调,记录当前已经落地的核心边界与使用方式。
|
||||||
|
|
||||||
> 更新日期:2026-09-02。第一阶段 AI Core、Agent Core、Extension Core 和 Model Core 主链路已经完成;第二阶段 Agent Trace 持久化、可恢复 SSE、stdio MCP Bridge、隔离 Plugin Host 以及 Plugin Command/Settings 已落地,后端当前回归基线为 107 项测试通过。
|
> 更新日期:2026-09-02。第一阶段 AI Core、Agent Core、Extension Core 和 Model Core 主链路已经完成;第二阶段 Agent Trace 持久化、可恢复 SSE、stdio MCP Bridge、隔离 Plugin Host 以及 Plugin Command/Settings 已落地,后端当前回归基线为 116 项测试通过。
|
||||||
|
|
||||||
## 当前实现
|
## 当前实现
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
> 本文档用于团队开发和模块联调,记录 Knowledge Core / Retrieval Core 已经落地的
|
> 本文档用于团队开发和模块联调,记录 Knowledge Core / Retrieval Core 已经落地的
|
||||||
> 模块边界、数据模型、接口与使用方式,对应分工表中的杨星萱。
|
> 模块边界、数据模型、接口与使用方式,对应分工表中的杨星萱。
|
||||||
|
|
||||||
> 更新日期:2026-09-02。第一阶段 Knowledge/Retrieval 主链路已经完成,并已接入 Agent Tool Registry;完整后端回归基线为 107 项测试通过。
|
> 更新日期:2026-09-02。第一阶段 Knowledge/Retrieval 主链路已经完成,并已接入 Agent Tool Registry;完整后端回归基线为 116 项测试通过。
|
||||||
|
|
||||||
## 当前实现
|
## 当前实现
|
||||||
|
|
||||||
|
|||||||
@@ -235,6 +235,7 @@ backend/extensions/fixtures/mcp-echo
|
|||||||
- `mcp-fixture.large`:验证结果大小上限;
|
- `mcp-fixture.large`:验证结果大小上限;
|
||||||
- `mcp-fixture.environment`:验证宿主 Secret/路径没有进入子进程;
|
- `mcp-fixture.environment`:验证宿主 Secret/路径没有进入子进程;
|
||||||
- `mcp-fixture.exit`:验证异常退出、Tool 注销和 Restart。
|
- `mcp-fixture.exit`:验证异常退出、Tool 注销和 Restart。
|
||||||
|
- `mcp-fixture.command`:作为 Plugin Command 专用 MCP Target,验证 Context 裁剪、Secret 传递和与 Agent Tool 的隔离。
|
||||||
|
|
||||||
Fixture 的 `tools/list` 使用两页响应,用于覆盖分页发现。测试还会启动缺少 tools capability、返回无效 Schema/initialize result,以及输出超长无换行 stdout 的变体。
|
Fixture 的 `tools/list` 使用两页响应,用于覆盖分页发现。测试还会启动缺少 tools capability、返回无效 Schema/initialize result,以及输出超长无换行 stdout 的变体。
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Plugin Command 与 Settings 开发说明
|
# Plugin Command 与 Settings 开发说明
|
||||||
|
|
||||||
> 更新日期:2026-09-02。本文记录第二阶段阶段 D 已实现的 Plugin Command Contribution、Plugin Settings Contribution、Secret 边界和前端 Service Contract。当前回归基线为后端 107 项测试、前端 29 项测试,TypeScript 类型检查和生产构建通过。
|
> 更新日期:2026-09-02。本文记录第二阶段阶段 D 已实现的 Plugin Command Contribution、Plugin Settings Contribution、Secret 边界和前端 Service Contract。当前回归基线为后端 116 项测试、前端 29 项测试,TypeScript 类型检查和生产构建通过。
|
||||||
|
|
||||||
## 1. 阶段目标
|
## 1. 阶段目标
|
||||||
|
|
||||||
@@ -21,7 +21,8 @@ Plugin 在 `plugin.yaml` 的 `contributes.commands` 与 `contributes.settings_se
|
|||||||
- `command_id`、标题、描述、宿主图标;
|
- `command_id`、标题、描述、宿主图标;
|
||||||
- `locations`:`command_palette`、`context_menu` 或 `toolbar`;
|
- `locations`:`command_palette`、`context_menu` 或 `toolbar`;
|
||||||
- `when` 与允许传入执行器的 Context 字段;
|
- `when` 与允许传入执行器的 Context 字段;
|
||||||
- 参数 JSON Schema、可选权限、受控 handler 和超时。
|
- 参数 JSON Schema、可选权限、执行目标和超时;
|
||||||
|
- 执行目标必须在宿主白名单 `handler` 与当前插件命名空间的 `mcp_tool` 之间二选一。
|
||||||
- 可选 `secrets` 字段:只声明当前 Command 允许按需读取的 Secret Setting Key,不暴露给前端 DTO。
|
- 可选 `secrets` 字段:只声明当前 Command 允许按需读取的 Secret Setting Key,不暴露给前端 DTO。
|
||||||
|
|
||||||
`settings.yaml` 采用递增 `schema_version`,首批字段类型固定为 `string`、`number`、`boolean`、`select`、`secret`。宿主会校验默认值、必填项、数值边界、Select 选项,以及 Secret 不得携带默认明文。
|
`settings.yaml` 采用递增 `schema_version`,首批字段类型固定为 `string`、`number`、`boolean`、`select`、`secret`。宿主会校验默认值、必填项、数值边界、Select 选项,以及 Secret 不得携带默认明文。
|
||||||
@@ -38,15 +39,17 @@ Plugin 在 `plugin.yaml` 的 `contributes.commands` 与 `contributes.settings_se
|
|||||||
2. 使用 Draft 2020-12 JSON Schema 校验 arguments;
|
2. 使用 Draft 2020-12 JSON Schema 校验 arguments;
|
||||||
3. 根据 `when` 检查必要上下文;
|
3. 根据 `when` 检查必要上下文;
|
||||||
4. 仅向执行器传递声明过的 Context 字段;
|
4. 仅向执行器传递声明过的 Context 字段;
|
||||||
5. 在超时范围内调用宿主受控 handler;
|
5. 在超时范围内调用宿主受控 handler,或调用独立的 MCP Command Target;
|
||||||
6. 校验 effect 类型、可序列化性和 64 KiB 大小上限;
|
6. 校验 effect 类型、可序列化性和 64 KiB 大小上限;
|
||||||
7. 返回统一 `PluginCommandResult`。
|
7. 返回统一 `PluginCommandResult`。
|
||||||
|
|
||||||
首批 effect 为 `none`、`notification`、`navigate`、`refresh` 和 `job`。前端不得把 effect 当作任意代码执行。
|
首批 effect 为 `none`、`notification`、`navigate`、`refresh` 和 `job`。前端不得把 effect 当作任意代码执行。
|
||||||
|
|
||||||
Command 执行器通过受控 Resolver 按需读取 `commands.yaml` 已声明且确实属于当前 Plugin Schema 的 Secret;使用 Secret 的 Plugin 还必须声明并获授 `secrets.use` 权限,读取未声明字段返回 `PLUGIN_SECRET_ACCESS_DENIED`。Secret 不会并入普通 Settings 字典。Command 审计使用 500 条有界内存队列,仅保留 `command_id`、`plugin_id`、成功/失败状态、耗时、错误码和时间。arguments、正文选区、文件路径、effect 与 Secret 均不进入审计事件。
|
Command 执行器通过受控 Resolver 按需读取 `commands.yaml` 已声明且确实属于当前 Plugin Schema 的 Secret;使用 Secret 的 Plugin 还必须声明并获授 `secrets.use` 权限。读取未声明字段返回 `PLUGIN_SECRET_ACCESS_DENIED`,必填 Secret 未配置则返回 `PLUGIN_SECRET_REQUIRED`。Secret 不会并入普通 Settings 字典。Command 审计使用 500 条有界内存队列,仅保留 `command_id`、`plugin_id`、成功/失败状态、耗时、错误码和时间。arguments、正文选区、文件路径、effect 与 Secret 均不进入审计事件。
|
||||||
|
|
||||||
当前声明式宿主提供安全白名单 handler,后续如允许 MCP Server 承担 Command 逻辑,应增加独立的 MCP Command Target Contract,不能把插件给出的模块路径或 Shell 字符串直接执行。
|
MCP Command Target 是专用执行目标,不注册进 Agent `ToolRegistry`,因此模型无法绕过 Command 权限与 Context 裁剪直接调用。宿主通过 `_notesagent` 保留包装传入 `command_id`、已校验 arguments、已裁剪 Context 和声明过的 Secret;MCP Server 必须返回结构化的白名单 effect。远程原始错误不直接透传给 HTTP 调用方。插件仍不能把模块路径或 Shell 字符串作为执行器。
|
||||||
|
|
||||||
|
Command 与 Tool 的 JSON Schema 只允许当前文档内的 Fragment 引用(`#...`);宿主在注册前递归拒绝 `$ref` / `$dynamicRef` 指向的文件、HTTP 或其他外部资源,避免 Schema 校验触发未授权 I/O。
|
||||||
|
|
||||||
## 4. Settings 与 Secret 边界
|
## 4. Settings 与 Secret 边界
|
||||||
|
|
||||||
@@ -60,7 +63,7 @@ APP_DATA_DIR/plugins/settings.json
|
|||||||
|
|
||||||
- 当前 Schema 版本;
|
- 当前 Schema 版本;
|
||||||
- 非敏感字段值;
|
- 非敏感字段值;
|
||||||
- Secret 的确定性引用,例如 `plugin.text-tools.api_key`。
|
- Secret 的确定性定长引用,格式为 `plugin.<sha256(plugin_id\\0setting_key)>`。
|
||||||
|
|
||||||
Secret 写入必须调用专用端点。后端通过 `SecretStr` 接收明文,再交给现有 `EncryptedCredentialStore`;普通 Settings API 只返回 `{ configured: true|false }`,不会返回 Secret 值。`plugin.*` 是保留命名空间,通用凭据 API、Provider 配置、Provider 临时测试凭据和 Provider Resolver 均不得访问,防止覆盖、删除或外发 Plugin Secret。卸载 Plugin 时同时删除普通设置命名空间和对应加密凭据。
|
Secret 写入必须调用专用端点。后端通过 `SecretStr` 接收明文,再交给现有 `EncryptedCredentialStore`;普通 Settings API 只返回 `{ configured: true|false }`,不会返回 Secret 值。`plugin.*` 是保留命名空间,通用凭据 API、Provider 配置、Provider 临时测试凭据和 Provider Resolver 均不得访问,防止覆盖、删除或外发 Plugin Secret。卸载 Plugin 时同时删除普通设置命名空间和对应加密凭据。
|
||||||
|
|
||||||
@@ -103,6 +106,6 @@ pnpm type-check
|
|||||||
pnpm build
|
pnpm build
|
||||||
```
|
```
|
||||||
|
|
||||||
阶段 D 测试覆盖注册/注销生命周期、位置过滤、参数与 Context 校验、上下文裁剪、设置影响命令执行、声明式 Secret Resolver 与越权拒绝、Provider/通用凭据命名空间隔离、五类设置字段、Schema 版本冲突、Secret 密文与清理、损坏存储、空 Command 列表等无效贡献文件、OpenAPI 路径和前端 Service 请求格式。
|
阶段 D 测试覆盖注册/注销生命周期、位置过滤、参数与 Context 校验、上下文裁剪、设置影响命令执行、声明式 Secret Resolver 与越权拒绝、真实 MCP Command Target 与 Agent Tool 隔离、必填 Secret 传递、外部 Schema 引用拒绝、定长 Secret Reference、Provider/通用凭据命名空间隔离、五类设置字段、Schema 版本冲突、Secret 密文与清理、损坏存储、空 Command 列表等无效贡献文件、OpenAPI 路径和前端 Service 请求格式。
|
||||||
|
|
||||||
生产构建仍会报告现有大 Chunk 警告,不影响构建成功;该问题属于前端按路由和 Markdown 依赖拆包的后续性能任务。
|
生产构建仍会报告现有大 Chunk 警告,不影响构建成功;该问题属于前端按路由和 Markdown 依赖拆包的后续性能任务。
|
||||||
|
|||||||
@@ -187,12 +187,12 @@ pnpm build
|
|||||||
```text
|
```text
|
||||||
pnpm build passed
|
pnpm build passed
|
||||||
pnpm test 29 passed
|
pnpm test 29 passed
|
||||||
uv run pytest 107 passed
|
uv run pytest 116 passed
|
||||||
preview smoke HTTP 200
|
preview smoke HTTP 200
|
||||||
git diff --check passed
|
git diff --check passed
|
||||||
```
|
```
|
||||||
|
|
||||||
当前前端使用 Vitest 执行 Store、Workspace API Adapter、SSE 恢复游标、Plugin Command/Settings Service、文件树、编辑器组件、智能体标签、轻量动效约束、Markdown 对比度 Token、scoped CSS 选择器约束和 Shiki GitHub 双主题测试;`pnpm build` 同时执行 `vue-tsc -b` 与 Vite 生产构建。后端测试出现过 `.pytest_cache` 无法写入的 Windows 权限警告,不影响 107 项测试结果,也不涉及产品代码。
|
当前前端使用 Vitest 执行 Store、Workspace API Adapter、SSE 恢复游标、Plugin Command/Settings Service、文件树、编辑器组件、智能体标签、轻量动效约束、Markdown 对比度 Token、scoped CSS 选择器约束和 Shiki GitHub 双主题测试;`pnpm build` 同时执行 `vue-tsc -b` 与 Vite 生产构建。后端测试出现过 `.pytest_cache` 无法写入的 Windows 权限警告,不影响 116 项测试结果,也不涉及产品代码。
|
||||||
|
|
||||||
Vite 当前会提示 Chat 与 Workspace 的部分异步 Chunk 超过 500 kB,这是 Milkdown、CodeMirror、KaTeX 和 Shiki 等编辑/渲染依赖带来的性能优化项,不影响构建成功或功能正确性;进入桌面打包前应通过手动分包或更细粒度动态加载继续优化。
|
Vite 当前会提示 Chat 与 Workspace 的部分异步 Chunk 超过 500 kB,这是 Milkdown、CodeMirror、KaTeX 和 Shiki 等编辑/渲染依赖带来的性能优化项,不影响构建成功或功能正确性;进入桌面打包前应通过手动分包或更细粒度动态加载继续优化。
|
||||||
|
|
||||||
|
|||||||
@@ -104,4 +104,4 @@ pnpm build
|
|||||||
|
|
||||||
自动化验证覆盖 Provider 预设、OpenAI-Compatible `/models` 请求与鉴权头、模型映射、前端自动刷新、排序去重及按 Provider 隔离错误。生产构建同时执行 Vue 和 TypeScript 类型检查。
|
自动化验证覆盖 Provider 预设、OpenAI-Compatible `/models` 请求与鉴权头、模型映射、前端自动刷新、排序去重及按 Provider 隔离错误。生产构建同时执行 Vue 和 TypeScript 类型检查。
|
||||||
|
|
||||||
当前完整回归基线:后端 107 项测试、前端 29 项测试通过,前端类型检查和生产构建通过。Provider 配置目前仍保存在内存 Registry,AI Core 重启后需要重新创建;凭据密文会保留。`plugin.*` 为 Plugin Secret 保留命名空间,Provider 配置、临时测试凭据和通用凭据 API 均拒绝该前缀。OpenAI Responses 与 Anthropic Messages Adapter 尚未实现,设置页正式预设不会使用这两种协议。
|
当前完整回归基线:后端 116 项测试、前端 29 项测试通过,前端类型检查和生产构建通过。Provider 配置目前仍保存在内存 Registry,AI Core 重启后需要重新创建;凭据密文会保留。`plugin.*` 为 Plugin Secret 保留命名空间,Provider 配置、临时测试凭据和通用凭据 API 均拒绝该前缀。OpenAI Responses 与 Anthropic Messages Adapter 尚未实现,设置页正式预设不会使用这两种协议。
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
> 审阅范围:FastAPI、Knowledge / Retrieval Core、Agent Core、Extension Core、Provider Adapter、公共接口和后端开发文档。
|
> 审阅范围:FastAPI、Knowledge / Retrieval Core、Agent Core、Extension Core、Provider Adapter、公共接口和后端开发文档。
|
||||||
> 文档用途:记录问题形成原因、实际影响、修复判断和落地方案,供后续开发文档、比赛材料与技术博客使用。
|
> 文档用途:记录问题形成原因、实际影响、修复判断和落地方案,供后续开发文档、比赛材料与技术博客使用。
|
||||||
|
|
||||||
> 2026-09-02 状态补充:本文记录的缺陷均保持修复。此后又加入 Provider 预设、模型发现、DeepSeek/OpenAI 凭据解析、Fernet 加密存储、Agent Trace 持久化、stdio MCP Plugin Host 和 Plugin Command/Settings,当前完整后端回归基线为 107 项测试通过。
|
> 2026-09-02 状态补充:本文记录的缺陷均保持修复。此后又加入 Provider 预设、模型发现、DeepSeek/OpenAI 凭据解析、Fernet 加密存储、Agent Trace 持久化、stdio MCP Plugin Host 和 Plugin Command/Settings,当前完整后端回归基线为 116 项测试通过。
|
||||||
|
|
||||||
## 1. 审阅结论
|
## 1. 审阅结论
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user