@xano/developer-mcp 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +261 -0
  3. package/api_docs/addon.md +193 -0
  4. package/api_docs/agent.md +154 -0
  5. package/api_docs/api_group.md +236 -0
  6. package/api_docs/authentication.md +68 -0
  7. package/api_docs/file.md +190 -0
  8. package/api_docs/function.md +217 -0
  9. package/api_docs/history.md +263 -0
  10. package/api_docs/index.md +104 -0
  11. package/api_docs/mcp_server.md +139 -0
  12. package/api_docs/middleware.md +205 -0
  13. package/api_docs/realtime.md +153 -0
  14. package/api_docs/table.md +151 -0
  15. package/api_docs/task.md +191 -0
  16. package/api_docs/tool.md +216 -0
  17. package/api_docs/triggers.md +344 -0
  18. package/api_docs/workspace.md +246 -0
  19. package/dist/index.d.ts +2 -0
  20. package/dist/index.js +495 -0
  21. package/package.json +49 -0
  22. package/xanoscript_docs/README.md +1 -0
  23. package/xanoscript_docs/api_query_examples.md +1255 -0
  24. package/xanoscript_docs/api_query_guideline.md +129 -0
  25. package/xanoscript_docs/build_from_lovable.md +715 -0
  26. package/xanoscript_docs/db_query_guideline.md +427 -0
  27. package/xanoscript_docs/ephemeral_environment_guideline.md +529 -0
  28. package/xanoscript_docs/expression_guideline.md +1086 -0
  29. package/xanoscript_docs/frontend_guideline.md +67 -0
  30. package/xanoscript_docs/function_examples.md +1406 -0
  31. package/xanoscript_docs/function_guideline.md +130 -0
  32. package/xanoscript_docs/functions.md +2155 -0
  33. package/xanoscript_docs/input_guideline.md +227 -0
  34. package/xanoscript_docs/mcp_server_examples.md +36 -0
  35. package/xanoscript_docs/mcp_server_guideline.md +69 -0
  36. package/xanoscript_docs/query_filter.md +489 -0
  37. package/xanoscript_docs/table_examples.md +586 -0
  38. package/xanoscript_docs/table_guideline.md +137 -0
  39. package/xanoscript_docs/task_examples.md +511 -0
  40. package/xanoscript_docs/task_guideline.md +103 -0
  41. package/xanoscript_docs/tips_and_tricks.md +144 -0
  42. package/xanoscript_docs/tool_examples.md +69 -0
  43. package/xanoscript_docs/tool_guideline.md +139 -0
  44. package/xanoscript_docs/unit_testing_guideline.md +328 -0
  45. package/xanoscript_docs/version.json +3 -0
  46. package/xanoscript_docs/workspace.md +17 -0
package/xanoscript_docs/frontend_guideline.md ADDED
@@ -0,0 +1,67 @@
1
+ # Guidelines for AI-Assisted Development of a Static Frontend for Xano
2
+
3
+ You are an expert frontend developer tasked with creating a frontend-only, static application that integrates with a Xano REST API. The application will be hosted on Xano's CDN, requiring no server-side rendering, and all frontend code must reside in the `static/` folder in the workspace (compatible with editors like VS Code).
4
+
5
+ !!! IMPORTANT !!!
6
+ DO NOT ASSUME ANYTHING ABOUT THE API FORMAT, YOU CANNOT CAPTURE ITS API INTERFACE BY JUST LOOKING AT THE QUERY/ENDPOINT CODE!
7
+ YOU MUST RETRIEVE THE API SPECIFICATIONS AND PULL THE LATEST OPENAPI SPECIFICATIONS FROM THE BACKEND!
8
+ !!! IMPORTANT !!!
9
+
10
+ Invoke the `get_xano_api_specifications` tool immediately to acquire comprehensive OpenAPI specifications. Catalog endpoints meticulously, noting paths, methods, schemas, authentication (e.g., JWT tokens), rate limits, and error schemas. This informs your API client design, ensuring type-safe integrations (e.g., via generated TypeScript interfaces).
11
+
12
+ ## Base Template
13
+
14
+ ### If no existing frontend is present
15
+
16
+ Create an html file for each feature in the `static/` folder. Start with `index.html` as the main entry point. Use Bootstrap 5 for styling and layout. Here is a basic template:
17
+
18
+ ```html
19
+ <!DOCTYPE html>
20
+ <html lang="en">
21
+ <head>
22
+ <meta charset="utf-8" />
23
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
24
+ <title>My Project</title>
25
+ <link
26
+ href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css"
27
+ rel="stylesheet"
28
+ integrity="sha384-sRIl4kxILFvY47J16cr9ZwB07vP4J8+LH7qKQnuqkuIAvNWLzeN8tE5YBujZqJLB"
29
+ crossorigin="anonymous"
30
+ />
31
+ <script src="https://cdn.jsdelivr.net/npm/lodash@4.17.21/lodash.min.js"></script>
32
+ <script
33
+ src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js"
34
+ integrity="sha384-FKyoEForCGlyvwx9Hj09JcYn3nv7wiPVlz7YYwJrWVcXK/BmnVDxM+D2scQbITxI"
35
+ crossorigin="anonymous"
36
+ ></script>
37
+ <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
38
+ </head>
39
+ <body>
40
+ <h1>Hello, world!</h1>
41
+ </body>
42
+ </html>
43
+ ```
44
+
45
+ Centralize API calls in a single `api.js` file, utilizing the Fetch API with async/await syntax. Ensure robust error handling and user feedback mechanisms.
46
+
47
+ ### If an existing frontend is present
48
+
49
+ Understand where the frontend was built from, lots of frontend are built from Loveable, see [Building from Loveable Guide](./build_from_lovable.md) to adapt the strategy accordingly. Inquiry the user if unsure.
50
+
51
+ If an existing frontend is present, do not modify the `index.html` file unless explicitly instructed. Try to understand the framework and libraries used, and continue development accordingly.
52
+
53
+ Leverage existing components and styles to maintain consistency. Ensure that any new code adheres to the established coding standards and practices of the existing codebase.
54
+
55
+ ### Authentication
56
+
57
+ Xano uses JWT tokens for authentication. Ensure your frontend securely handles token storage and renewal, the default endpoints for authentication read the bearer token from the `Authorization` header.
58
+
59
+ ## Deployment
60
+
61
+ Upon completion, invoke the `upload_static_files_to_xano` tool to synchronize `static/` contents, triggering builds and yielding the hosted URL. Convey this URL to the user, along with deployment artifacts (e.g., build logs) and recommendations for monitoring (e.g., via browser dev tools or Xano analytics).
62
+
63
+ ## Best Practices
64
+
65
+ !!! IMPORTANT !!!
66
+ REMEMBER TO ALWAYS PULL THE LATEST OPENAPI SPECIFICATIONS FROM THE BACKEND USING THE `get_xano_api_specifications` TOOL BEFORE WRITING ANY CODE.
67
+ !!! IMPORTANT !!!