Skip to content

Update Python pip package to signalwire-sdk and comment out TypeScript in guides #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Devon-White merged 2 commits into from
Apr 12, 2026
Merged

Update Python pip package to signalwire-sdk and comment out TypeScript in guides #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32556f6
Update Python pip package from signalwire to @signalwire/sdk and comm…
fern-api[bot] Apr 12, 2026
0c6fd50
Fix Python pip package name to signalwire-sdk
fern-api[bot] Apr 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/adding-skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, DateTimeSkill, MathSkill } from 'signalwire-agents';
Expand All @@ -316,6 +317,7 @@ agent.promptAddSection('Capabilities', {
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/agent-base.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ if __name__ == "__main__":
agent.run(host="0.0.0.0", port=3000)
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand All @@ -149,6 +150,7 @@ agent.setPostPrompt('Summarize: issue type, resolution, customer satisfaction');
agent.run({ host: '0.0.0.0', port: 3000 });
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/ai-parameters.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase } from 'signalwire-agents';
Expand All @@ -226,6 +227,7 @@ agent.promptAddSection('Role', { body: 'You are a helpful customer service agent
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/architecture.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand All @@ -388,6 +389,7 @@ agent.addSkill('datetime');
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 1 addition & 1 deletion fern/products/server-sdks/pages/guides/build-ai-agents/builtin-skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ Local vector search using .swsearch index files.

- `search_knowledge` - Search local vector index

**Requirements:** Search extras installed (`pip install "signalwire[search]"`)
**Requirements:** Search extras installed (`pip install "signalwire-sdk[search]"`)

```python
from signalwire import AgentBase
Expand Down
6 changes: 6 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/call-flow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase } from 'signalwire-agents';
Expand All @@ -96,6 +97,7 @@ agent.promptAddSection('Role', { body: 'You are a helpful assistant.' });
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down Expand Up @@ -267,6 +269,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase } from 'signalwire-agents';
Expand All @@ -282,6 +285,7 @@ agent.promptAddSection('Role', {
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down Expand Up @@ -495,6 +499,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase } from 'signalwire-agents';
Expand All @@ -512,6 +517,7 @@ agent.addPostAiVerb('hangup', {});
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/call-transfer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand Down Expand Up @@ -356,6 +357,7 @@ agent.defineTool({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/concierge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { ConciergeAgent } from 'signalwire-agents';
Expand All @@ -46,6 +47,7 @@ const agent = new ConciergeAgent({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/contexts-workflows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase } from 'signalwire-agents';
Expand All @@ -135,6 +136,7 @@ order.addStep('confirm', { task: 'Confirm the order details and thank them.' })
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/custom-skills.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ class GreetingSkill(SkillBase):
return FunctionResult(greeting)
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { SkillBase, FunctionResult, AgentBase } from 'signalwire-agents';
Expand Down Expand Up @@ -135,6 +136,7 @@ class GreetingSkill extends SkillBase {
}
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/datamap.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ class WeatherAgent(AgentBase):
self.register_swaig_function(weather_dm.to_swaig_function())
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand All @@ -111,6 +112,7 @@ const weatherDm = new DataMap('get_weather')
agent.registerSwaigFunction(weatherDm.toSwaigFunction());
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/defining-functions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand Down Expand Up @@ -112,6 +113,7 @@ agent.defineTool({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/faq-bot.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { FAQBotAgent } from 'signalwire-agents';
Expand All @@ -50,6 +51,7 @@ const agent = new FAQBotAgent({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/hints.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand All @@ -382,6 +383,7 @@ agent.defineTool({ name: 'lookup_product', description: 'Look up product by SKU'
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/info-gatherer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { InfoGathererAgent } from 'signalwire-agents';
Expand All @@ -41,6 +42,7 @@ const agent = new InfoGathererAgent({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/lifecycle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ class MyAgent(AgentBase):
self.log_call_summary(call_id, summary)
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
agent.setPostPrompt(
Expand All @@ -165,6 +166,7 @@ agent.onSummary((summary, rawData) => {
});
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 1 addition & 1 deletion fern/products/server-sdks/pages/guides/build-ai-agents/mcp-gateway.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The MCP Gateway acts as a bridge: it runs MCP servers and exposes their tools as
The MCP Gateway is included in the SignalWire Agents SDK. Install with the gateway dependencies:

```bash
pip install "signalwire[mcp-gateway]"
pip install "signalwire-sdk[mcp-gateway]"
```

Once installed, the `mcp-gateway` CLI command is available:
Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/multi-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ if __name__ == "__main__":
server.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, AgentServer } from 'signalwire-agents';
Expand All @@ -88,6 +89,7 @@ server.register(support, '/support');
server.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/prompts-pom.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,15 @@ class MyAgent(AgentBase):
)
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase } from 'signalwire-agents';
const agent = new AgentBase({ name: 'my-agent' });
agent.promptAddSection('Role', { body: 'You are a helpful customer service representative for Acme Corp.' });
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/receptionist.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { ReceptionistAgent } from 'signalwire-agents';
Expand All @@ -53,6 +54,7 @@ const agent = new ReceptionistAgent({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/results-actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ def check_order(self, args, raw_data):
return FunctionResult(f"Order {order_number} shipped yesterday")
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { FunctionResult } from 'signalwire-agents';
Expand All @@ -30,6 +31,7 @@ function checkOrder(args: Record<string, any>): FunctionResult {
}
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
10 changes: 5 additions & 5 deletions fern/products/server-sdks/pages/guides/build-ai-agents/search-knowledge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,19 +113,19 @@ sw-search ./docs \

```bash
## Query-only (smallest footprint)
pip install "signalwire[search-queryonly]"
pip install "signalwire-sdk[search-queryonly]"

## Build indexes + vector search
pip install "signalwire[search]"
pip install "signalwire-sdk[search]"

## Full features (PDF, DOCX processing)
pip install "signalwire[search-full]"
pip install "signalwire-sdk[search-full]"

## All features including NLP
pip install "signalwire[search-all]"
pip install "signalwire-sdk[search-all]"

## PostgreSQL pgvector support
pip install "signalwire[pgvector]"
pip install "signalwire-sdk[pgvector]"
```

### Using Search in Agents
Expand Down
2 changes: 2 additions & 0 deletions fern/products/server-sdks/pages/guides/build-ai-agents/state-management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,7 @@ if __name__ == "__main__":
agent.run()
```
</Tab>
{/*
<Tab title="TypeScript">
```typescript
import { AgentBase, FunctionResult } from 'signalwire-agents';
Expand Down Expand Up @@ -451,6 +452,7 @@ agent.defineTool({
agent.run();
```
</Tab>
*/}
</Tabs>
{/*

Expand Down
Loading
Loading