soulfire.api_docs_pb2.ApiMethodDocs¶
- class soulfire.api_docs_pb2.ApiMethodDocs(display_name: str | None = ..., description: str | None = ..., permissions: collections.abc.Iterable[str] | None = ..., scope: str | None = ..., preconditions: collections.abc.Iterable[str] | None = ..., execution: str | None = ..., side_effects: collections.abc.Iterable[str] | None = ..., expose_to_mcp: bool = ..., mcp_requires_confirmation: bool = ...)¶
Bases:
google.protobuf.message.MessageAbstract base class for protocol messages.
Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.
- DISPLAY_NAME_FIELD_NUMBER: ClassVar[int]¶
- DESCRIPTION_FIELD_NUMBER: ClassVar[int]¶
- PERMISSIONS_FIELD_NUMBER: ClassVar[int]¶
- SCOPE_FIELD_NUMBER: ClassVar[int]¶
- PRECONDITIONS_FIELD_NUMBER: ClassVar[int]¶
- EXECUTION_FIELD_NUMBER: ClassVar[int]¶
- SIDE_EFFECTS_FIELD_NUMBER: ClassVar[int]¶
- EXPOSE_TO_MCP_FIELD_NUMBER: ClassVar[int]¶
- MCP_REQUIRES_CONFIRMATION_FIELD_NUMBER: ClassVar[int]¶
- display_name: str¶
- description: str¶
- permissions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]¶
- scope: str¶
- preconditions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]¶
- execution: str¶
- side_effects: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]¶
- expose_to_mcp: bool¶
- mcp_requires_confirmation: bool¶