docs: align README with the SDK's actual capabilities#7
Merged
Conversation
The README documented sub-clients and methods that do not exist in the code: client.reasoning.*, client.toolclad.*, client.evaluate_communication() / communication rule management, and add_cedar_policy — none are implemented. It also used a metrics API that doesn't exist (get_metrics_snapshot, wrong MetricsCollector constructor). Rewrite the capabilities table, Trust Stack section, and examples to reflect the real surface: agents & workflows, messaging, auth/health/metrics on Client; schedules/channels/agentpin/metrics_client sub-clients; and the standalone MarkdownMemoryStore / SkillScanner / webhook verifiers. Cedar, ToolClad, SchemaPin, and the Communication Policy Gate are noted as runtime-enforced (server-side), not SDK-driven.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README documented sub-clients/methods that don't exist in the code:
client.reasoning.*,client.toolclad.*,client.evaluate_communication()/ communication rules,add_cedar_policy, and a non-existent metrics API (get_metrics_snapshot, wrongMetricsCollectorconstructor).Rewrites the capabilities table, Trust Stack section, and examples to match the real surface (verified against
symbiont/*.py): agents & workflows, messaging, auth/health/metrics onClient;schedules/channels/agentpin/metrics_clientsub-clients; standaloneMarkdownMemoryStore/SkillScanner/webhook verifiers. Cedar/ToolClad/SchemaPin/Comm-gate are noted as runtime-enforced (server-side).