Skip to content

Commit 1693f95

Browse files
authored
Rename app description to instructions (#152)
1 parent b918eca commit 1693f95

File tree

28 files changed

+83
-68
lines changed

28 files changed

+83
-68
lines changed

docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The main application class that manages entities, relationships, and resources.
1010
```python
1111
from enrichmcp import EnrichMCP
1212

13-
app = EnrichMCP(title="My API", description="API for AI agents")
13+
app = EnrichMCP(title="My API", instructions="API for AI agents")
1414
```
1515

1616
### [EnrichModel](api/entity.md)

docs/api/app.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ The `EnrichMCP` class is the main entry point for creating an enrichmcp applicat
1111

1212
## Class Reference
1313

14-
### `EnrichMCP(title: str, description: str)`
14+
### `EnrichMCP(title: str, instructions: str)`
1515

1616
Creates a new enrichmcp application.
1717

1818
**Parameters:**
1919
- `title`: The name of your API
20-
- `description`: A description of what your API provides
20+
- `instructions`: Instructions for interacting with your API
2121

2222
**Example:**
2323
```python
2424
from enrichmcp import EnrichMCP
2525

26-
app = EnrichMCP(title="My API", description="API for AI agents to access my data")
26+
app = EnrichMCP(title="My API", instructions="API for AI agents to access my data")
2727
```
2828

2929
## Methods
@@ -120,7 +120,7 @@ async def custom_tool(x: int) -> int:
120120
Return the current request context as an :class:`~enrichmcp.EnrichContext`.
121121

122122
```python
123-
app = EnrichMCP("My API", description="desc")
123+
app = EnrichMCP("My API", instructions="desc")
124124
ctx = app.get_context()
125125
assert ctx.fastmcp is app.mcp
126126
```
@@ -208,7 +208,7 @@ from enrichmcp import EnrichMCP, EnrichModel, Relationship
208208
from pydantic import Field
209209

210210
# Create app
211-
app = EnrichMCP(title="Bookstore API", description="API for managing books and authors")
211+
app = EnrichMCP(title="Bookstore API", instructions="API for managing books and authors")
212212

213213

214214
# Define entities

docs/examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ from enrichmcp import EnrichMCP, EnrichModel, Relationship
1212
from pydantic import Field
1313

1414
# Create the application
15-
app = EnrichMCP(title="Book Catalog API", description="A simple book catalog for AI agents")
15+
app = EnrichMCP(title="Book Catalog API", instructions="A simple book catalog for AI agents")
1616

1717

1818
# Define entities
@@ -155,7 +155,7 @@ from enrichmcp import EnrichMCP, EnrichModel, Relationship
155155
from pydantic import Field
156156

157157
app = EnrichMCP(
158-
title="Task Management API", description="Simple task tracking system for AI agents"
158+
title="Task Management API", instructions="Simple task tracking system for AI agents"
159159
)
160160

161161

@@ -332,7 +332,7 @@ A recipe API demonstrating many-to-many style relationships:
332332
from enrichmcp import EnrichMCP, EnrichModel, Relationship
333333
from pydantic import Field
334334

335-
app = EnrichMCP(title="Recipe API", description="A collection of recipes with ingredients")
335+
app = EnrichMCP(title="Recipe API", instructions="A collection of recipes with ingredients")
336336

337337

338338
@app.entity

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ from enrichmcp import EnrichMCP, EnrichModel, Relationship
7272
from pydantic import Field
7373

7474
# Create the application
75-
app = EnrichMCP(title="Book Catalog API", description="A simple book catalog for AI agents")
75+
app = EnrichMCP(title="Book Catalog API", instructions="A simple book catalog for AI agents")
7676

7777

7878
# Define entities
@@ -254,7 +254,7 @@ class Product(Base):
254254

255255

256256
lifespan = sqlalchemy_lifespan(Base, engine, cleanup_db_file=True)
257-
app = EnrichMCP("My ORM API", lifespan=lifespan)
257+
app = EnrichMCP("My ORM API", instructions="ORM API", lifespan=lifespan)
258258
include_sqlalchemy_models(app, Base)
259259
app.run()
260260
```

docs/pagination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ EnrichMCP provides comprehensive pagination support for both page-based and curs
88
from enrichmcp import EnrichMCP, EnrichModel, PageResult, CursorResult
99
from pydantic import Field
1010

11-
app = EnrichMCP(title="My API", description="API with pagination")
11+
app = EnrichMCP(title="My API", instructions="API with pagination")
1212

1313

1414
@app.entity

examples/basic_memory/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
store = FileMemoryStore(Path(__file__).parent / "data")
2424
project = MemoryProject("demo", store)
2525

26-
app = EnrichMCP(title="Basic Memory API", description="Manage simple notes")
26+
app = EnrichMCP(title="Basic Memory API", instructions="Manage simple notes")
2727

2828

2929
@app.entity

examples/caching/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
from enrichmcp import EnrichMCP
77

8-
app = EnrichMCP("Caching API", description="Demo of request caching")
8+
app = EnrichMCP("Caching API", instructions="Demo of request caching")
99

1010

1111
@app.retrieve

examples/hello_world/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
def main():
1212
# Create the EnrichMCP application
13-
app = EnrichMCP(title="Hello World API", description="A simple API that says hello!")
13+
app = EnrichMCP(title="Hello World API", instructions="A simple API that says hello!")
1414

1515
# Define a hello world resource
1616
@app.retrieve(description="Say hello to the world")

examples/hello_world_http/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55

66
def main() -> None:
7-
app = EnrichMCP(title="Hello HTTP API", description="A simple HTTP example")
7+
app = EnrichMCP(title="Hello HTTP API", instructions="A simple HTTP example")
88

99
@app.retrieve(description="Say hello over HTTP")
1010
async def hello_http() -> dict[str, str]:

examples/mutable_crud/app.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
app = EnrichMCP(
88
title="Customer CRUD API",
9-
description="Demonstrates mutability and CRUD decorators",
9+
instructions="Demonstrates mutability and CRUD decorators",
1010
)
1111

1212

0 commit comments

Comments
 (0)