You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 121977d
Browse filesBrowse the repository at this point in the historyBrowse files
Use the absolute workspace path when configuring your MCP client. See the [adapter README](https://github.com/fullbleed-engine/fullbleed-official/tree/master/packages/fullbleed-mcp) for client setup and tool definitions. The core also includes `python -m fullbleed mcp --root .`.
37
+
In your client's **stdio server** settings, use the Python executable printed
Both entrypoints share the runtime implementation.
52
+
53
+
### Check the connection
54
+
55
+
After restarting the client, ask it to list the Fullbleed tools and call
56
+
`fullbleed_capabilities`. The installed engine reports its version and supported
57
+
capabilities. Use `fullbleed_agent_contract` for detailed tool schemas before
58
+
constructing requests.
59
+
60
+
| Task | Tool |
61
+
| --- | --- |
62
+
| Discover the installed engine |`fullbleed_capabilities`|
63
+
| Read argument and result schemas |`fullbleed_agent_contract`|
64
+
| Render a PDF and page images |`fullbleed_render_preview`|
65
+
| Inspect the generated PDF |`fullbleed_inspect`|
66
+
| Check a document against selected diagnostics |`fullbleed_verify`|
67
+
68
+
The [adapter README](https://github.com/fullbleed-engine/fullbleed-official/tree/master/packages/fullbleed-mcp)
69
+
also covers Docker and registry metadata. Its development checks use the official
70
+
MCP TypeScript client to exercise tool discovery, structured results, a rendered
71
+
PDF, and a tool error.
72
+
73
+
### Troubleshoot setup
74
+
75
+
| Symptom | Next step |
76
+
| --- | --- |
77
+
| Tool discovery rejects `outputSchema.type`| Upgrade the engine to 2.5.1 or newer in the same Python environment used by the client, then restart the client. |
78
+
| The client cannot find the command or module | Use the absolute Python executable from the installation environment; check that it can run `-m fullbleed_mcp --help`. |
79
+
| A tool rejects an input or output path | Keep the document and its assets inside the configured `--root` workspace. |
80
+
| A terminal appears to wait after starting the server | This is a stdio process waiting for protocol messages. Configure your MCP client to launch it. |
34
81
35
82
## Give the agent a concrete document task
36
83
37
84
> Use Fullbleed to create an invoice from my JSON. Discover the installed runtime first. Keep assets local, escape input text, render the PDF and PNG previews, inspect every page, and verify that the invoice number, line items, and total appear in the output. Return the PDF and any unresolved diagnostics.
38
85
39
-
Add the target page size, fonts, expected page count, and output profile when these matter. Use the [complete workflow examples](../examples.md) as runnable starting points.
86
+
Add the target page size, fonts, expected page count, and output profile when these matter.
87
+
For a stronger visual starting point, give the agent the
88
+
[Northstar invoice](../examples.md#styled-invoice) or
89
+
[Common Ground report](../examples.md#business-report) source bundle, including
90
+
its fonts. Ask it to preserve the design while replacing the fictional content
Copy file name to clipboardExpand all lines: docs/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,6 +87,6 @@ Fullbleed uses static HTML/CSS as its layout language. Read the [CSS coverage](c
87
87
88
88
## Open source, with inspectable evidence
89
89
90
-
Fullbleed is [MIT licensed](https://github.com/fullbleed-engine/fullbleed-official/blob/master/LICENSE). The [2.5.0 release](https://github.com/fullbleed-engine/fullbleed-official/releases/tag/v2.5.0) includes downloadable wheels and retained engineering evidence. The [performance report](guides/performance.md) describes specific measured workloads and their limits.
90
+
Fullbleed is [MIT licensed](https://github.com/fullbleed-engine/fullbleed-official/blob/master/LICENSE). The [2.5.1 release](https://github.com/fullbleed-engine/fullbleed-official/releases/tag/v2.5.1) includes downloadable wheels and retained engineering evidence. The [performance report](guides/performance.md) describes specific measured workloads and their limits.
91
91
92
92
[Read the Python API](engine/pdf-engine.md) · [Set up a coding agent](guides/ai-agents.md) · [Report an issue](https://github.com/fullbleed-engine/fullbleed-official/issues)
0 commit comments