import json
import requests
import os
from requests.adapters import HTTPAdapter
from urllib3.util.retry import Retry
def update_bookshelf(id: int, name: str = None, description: str = None, books: list = None, tags: list = None) -> str:
"""
Updates a bookshelf in Bookstack.
This function supports two usage scenarios:
1) Updating a bookshelf
2) Retrieving the tool's metadata by passing id="__tool_info__"
Args:
id (int): The ID of the bookshelf to update
name (str, optional): The new name of the bookshelf
description (str, optional): A new description of the bookshelf
books (list, optional): A new list of book IDs to include in the shelf
tags (list, optional): A new list of tag objects (each with 'name' and 'value')
Returns:
str: JSON-formatted string containing the response
"""
if id == "__tool_info__":
info = {
"name": "update_bookshelf",
"description": "Updates a bookshelf in Bookstack",
"args": {
"id": {
"type": "int",
"description": "The ID of the bookshelf to update",
"required": True
},
"name": {
"type": "string",
"description": "The new name of the bookshelf",
"required": False
},
"description": {
"type": "string",
"description": "A new description of the bookshelf",
"required": False
},
"books": {
"type": "list",
"description": "A new list of book IDs to include in the shelf",
"required": False
},
"tags": {
"type": "list",
"description": "A new list of tag objects (each with 'name' and 'value')",
"required": False
}
}
}
return json.dumps(info)
if not isinstance(id, int) or id <= 0:
return json.dumps({"error": "Valid bookshelf ID is required"})
if not any([name, description, books, tags]):
return json.dumps({"error": "At least one field to update must be provided"})
base_url = os.environ.get("BS_URL", "https://knowledge.oculair.ca").rstrip("/")
token_id = os.environ.get("BS_TOKEN_ID")
token_secret = os.environ.get("BS_TOKEN_SECRET")
if not token_id or not token_secret:
return json.dumps({"error": "BS_TOKEN_ID and BS_TOKEN_SECRET environment variables must be set."})
try:
session = requests.Session()
adapter = HTTPAdapter(max_retries=Retry(
total=3,
backoff_factor=1,
status_forcelist=[429, 500, 502, 503, 504]
))
session.mount("http://", adapter)
session.mount("https://", adapter)
headers = {
"Authorization": f"Token {token_id}:{token_secret}",
"Content-Type": "application/json"
}
# Get current bookshelf data first
try:
current_shelf = session.get(
f"{base_url}/api/shelves/{id}",
headers=headers,
timeout=30
)
current_shelf.raise_for_status()
current_data = current_shelf.json()
except requests.exceptions.RequestException as e:
return json.dumps({"error": f"Failed to retrieve current bookshelf data - {str(e)}"})
# Prepare update payload with current values as defaults
payload = {
"name": name if name is not None else current_data.get("name", ""),
"description": description if description is not None else current_data.get("description", "")
}
if books is not None:
payload["books"] = books
if tags is not None:
payload["tags"] = tags
response = session.put(
f"{base_url}/api/shelves/{id}",
headers=headers,
json=payload,
timeout=30
)
response.raise_for_status()
return json.dumps(response.json())
except requests.exceptions.RequestException as e:
return json.dumps({"error": f"Network or HTTP error - {str(e)}"})
except Exception as e:
return json.dumps({"error": f"Unexpected error - {str(e)}"})
finally:
session.close()
if __name__ == "__main__":
print("Testing update_bookshelf tool...")
# Set up environment with credentials
os.environ["BS_URL"] = "https://knowledge.oculair.ca"
os.environ["BS_TOKEN_ID"] = "POnHR9Lbvm73T2IOcyRSeAqpA8bSGdMT"
os.environ["BS_TOKEN_SECRET"] = "735wM5dScfUkcOy7qcrgqQ1eC5fBF7IE"
print("\nConfiguration:")
print(f"API Base URL: {os.environ.get('BS_URL')}")
print(f"Authorization header: Token {os.environ.get('BS_TOKEN_ID')}:{os.environ.get('BS_TOKEN_SECRET')[:10]}...")
# Retrieve tool info
print("\nTool Information:")
tool_info = update_bookshelf("__tool_info__", 0)
print(json.dumps(json.loads(tool_info), indent=4))
# Example bookshelf update
print("\nUpdating test bookshelf (ID: 3)...")
try:
updated_shelf = update_bookshelf(
3, # Update our test bookshelf
name="Updated Test Bookshelf",
description="This bookshelf has been updated via the API.",
books=[7], # Keep book ID 7
tags=[{"name": "updated", "value": "true"}]
)
response = json.loads(updated_shelf)
if "error" in response:
print(f"Error updating bookshelf: {response['error']}")
else:
print("Bookshelf updated successfully!")
print(json.dumps(response, indent=2))
except Exception as e:
print(f"Error during test: {str(e)}")
